LongRange
represents an inclusive range of long
s.
Constructs a new LongRange
using the specified
* number as both the minimum and maximum in this range.
Constructs a new LongRange
using the specified
* number as both the minimum and maximum in this range.
null
* @throws IllegalArgumentException if the number is null
*/
public LongRange(Number number) {
super();
if (number == null) {
throw new IllegalArgumentException("The number must not be null");
}
this.min = number.longValue();
this.max = number.longValue();
if (number instanceof Long) {
this.minObject = (Long) number;
this.maxObject = (Long) number;
}
}
/**
* Constructs a new LongRange
with the specified
* minimum and maximum numbers (both inclusive).
The arguments may be passed in the order (min,max) or (max,min). The * getMinimum and getMaximum methods will return the correct values.
* * @param number1 first number that defines the edge of the range, inclusive * @param number2 second number that defines the edge of the range, inclusive */ public LongRange(long number1, long number2) { super(); if (number2 < number1) { this.min = number2; this.max = number1; } else { this.min = number1; this.max = number2; } } /** *Constructs a new LongRange
with the specified
* minimum and maximum numbers (both inclusive).
The arguments may be passed in the order (min,max) or (max,min). The * getMinimum and getMaximum methods will return the correct values.
* * @param number1 first number that defines the edge of the range, inclusive * @param number2 second number that defines the edge of the range, inclusive * @throws IllegalArgumentException if either number isnull
*/
public LongRange(Number number1, Number number2) {
super();
if (number1 == null || number2 == null) {
throw new IllegalArgumentException("The numbers must not be null");
}
long number1val = number1.longValue();
long number2val = number2.longValue();
if (number2val < number1val) {
this.min = number2val;
this.max = number1val;
if (number2 instanceof Long) {
this.minObject = (Long) number2;
}
if (number1 instanceof Long) {
this.maxObject = (Long) number1;
}
} else {
this.min = number1val;
this.max = number2val;
if (number1 instanceof Long) {
this.minObject = (Long) number1;
}
if (number2 instanceof Long) {
this.maxObject = (Long) number2;
}
}
}
// Accessors
//--------------------------------------------------------------------
/**
* Returns the minimum number in this range.
* * @return the minimum number in this range */ public Number getMinimumNumber() { if (minObject == null) { minObject = new Long(min); } return minObject; } /** *Gets the minimum number in this range as a long
.
Gets the minimum number in this range as a int
.
This conversion can lose information for large values.
* * @return the minimum number in this range */ public int getMinimumInteger() { return (int) min; } /** *Gets the minimum number in this range as a double
.
This conversion can lose information for large values.
* * @return the minimum number in this range */ public double getMinimumDouble() { return min; } /** *Gets the minimum number in this range as a float
.
This conversion can lose information for large values.
* * @return the minimum number in this range */ public float getMinimumFloat() { return min; } /** *Returns the maximum number in this range.
* * @return the maximum number in this range */ public Number getMaximumNumber() { if (maxObject == null) { maxObject = new Long(max); } return maxObject; } /** *Gets the maximum number in this range as a long
.
Gets the maximum number in this range cast to an int
.
This conversion can lose information for large values.
* * @return the maximum number in this range cast to anint
.
*/
public int getMaximumInteger() {
return (int) max;
}
/**
* Gets the maximum number in this range as a double
.
This conversion can lose information for large values.
* * @return The maximum number in this range as adouble
.
*/
public double getMaximumDouble() {
return max;
}
/**
* Gets the maximum number in this range as a float
.
This conversion can lose information for large values.
* * @return The maximum number in this range as afloat
.
*/
public float getMaximumFloat() {
return max;
}
// Tests
//--------------------------------------------------------------------
/**
* Tests whether the specified number
occurs within
* this range using long
comparison.
null
is handled and returns false
.
null
* @return true
if the specified number occurs within this range
*/
public boolean containsNumber(Number number) {
if (number == null) {
return false;
}
return containsLong(number.longValue());
}
/**
* Tests whether the specified long
occurs within
* this range using long
comparison.
This implementation overrides the superclass for performance as it is * the most common case.
* * @param value the long to test * @returntrue
if the specified number occurs within this
* range by long
comparison
*/
public boolean containsLong(long value) {
return value >= min && value <= max;
}
// Range tests
//--------------------------------------------------------------------
/**
* Tests whether the specified range occurs entirely within this range
* using long
comparison.
null
is handled and returns false
.
null
* @return true
if the specified range occurs entirely within this range
* @throws IllegalArgumentException if the range is not of this type
*/
public boolean containsRange(Range range) {
if (range == null) {
return false;
}
return containsLong(range.getMinimumLong()) &&
containsLong(range.getMaximumLong());
}
/**
* Tests whether the specified range overlaps with this range
* using long
comparison.
null
is handled and returns false
.
null
* @return true
if the specified range overlaps with this range
*/
public boolean overlapsRange(Range range) {
if (range == null) {
return false;
}
return range.containsLong(min) ||
range.containsLong(max) ||
containsLong(range.getMinimumLong());
}
// Basics
//--------------------------------------------------------------------
/**
* Compares this range to another object to test if they are equal.
. * *To be equal, the class, minimum and maximum must be equal.
* * @param obj the reference object with which to compare * @returntrue
if this object is equal
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof LongRange == false) {
return false;
}
LongRange range = (LongRange) obj;
return min == range.min && max == range.max;
}
/**
* Gets a hashCode for the range.
* * @return a hash code value for this object */ public int hashCode() { if (hashCode == 0) { hashCode = 17; hashCode = 37 * hashCode + getClass().hashCode(); hashCode = 37 * hashCode + ((int) (min ^ (min >> 32))); hashCode = 37 * hashCode + ((int) (max ^ (max >> 32))); } return hashCode; } /** *Gets the range as a String
.
The format of the String is 'Range[min,max]'.
* * @return theString
representation of this range
*/
public String toString() {
if (toString == null) {
StringBuffer buf = new StringBuffer(32);
buf.append("Range[");
buf.append(min);
buf.append(',');
buf.append(max);
buf.append(']');
toString = buf.toString();
}
return toString;
}
/**
* Returns an array containing all the long values in the range.
* * @return thelong[]
representation of this range
* @since 2.4
*/
public long[] toArray() {
long[] array = new long[(int)(max - min + 1L)];
for(int i = 0; i < array.length; i++) {
array[i] = min + i;
}
return array;
}
}
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Range
represents a range of numbers of the same type.
Specific subclasses hold the range values as different types. Each * subclass should be immutable and {@link java.io.Serializable Serializable} * if possible.
* * @author Stephen Colebourne * @since 2.0 * @version $Id: Range.java 437554 2006-08-28 06:21:41Z bayard $ */ abstract class Range { /** *Constructs a new range.
*/ public Range() { super(); } // Accessors //-------------------------------------------------------------------- /** *Gets the minimum number in this range.
* * @return the minimum number in this range */ public abstract Number getMinimumNumber(); /** *Gets the minimum number in this range as a long
.
This implementation uses the {@link #getMinimumNumber()} method. * Subclasses may be able to optimise this.
* * @return the minimum number in this range */ public long getMinimumLong() { return getMinimumNumber().longValue(); } /** *Gets the minimum number in this range as a int
.
This implementation uses the {@link #getMinimumNumber()} method. * Subclasses may be able to optimise this.
* * @return the minimum number in this range */ public int getMinimumInteger() { return getMinimumNumber().intValue(); } /** *Gets the minimum number in this range as a double
.
This implementation uses the {@link #getMinimumNumber()} method. * Subclasses may be able to optimise this.
* * @return the minimum number in this range */ public double getMinimumDouble() { return getMinimumNumber().doubleValue(); } /** *Gets the minimum number in this range as a float
.
This implementation uses the {@link #getMinimumNumber()} method. * Subclasses may be able to optimise this.
* * @return the minimum number in this range */ public float getMinimumFloat() { return getMinimumNumber().floatValue(); } /** *Gets the maximum number in this range.
* * @return the maximum number in this range */ public abstract Number getMaximumNumber(); /** *Gets the maximum number in this range as a long
.
This implementation uses the {@link #getMaximumNumber()} method. * Subclasses may be able to optimise this.
* * @return the maximum number in this range */ public long getMaximumLong() { return getMaximumNumber().longValue(); } /** *Gets the maximum number in this range as a int
.
This implementation uses the {@link #getMaximumNumber()} method. * Subclasses may be able to optimise this.
* * @return the maximum number in this range */ public int getMaximumInteger() { return getMaximumNumber().intValue(); } /** *Gets the maximum number in this range as a double
.
This implementation uses the {@link #getMaximumNumber()} method. * Subclasses may be able to optimise this.
* * @return the maximum number in this range */ public double getMaximumDouble() { return getMaximumNumber().doubleValue(); } /** *Gets the maximum number in this range as a float
.
This implementation uses the {@link #getMaximumNumber()} method. * Subclasses may be able to optimise this.
* * @return the maximum number in this range */ public float getMaximumFloat() { return getMaximumNumber().floatValue(); } // Include tests //-------------------------------------------------------------------- /** *Tests whether the specified Number
occurs within
* this range.
The exact comparison implementation varies by subclass. It is
* intended that an int
specific subclass will compare using
* int
comparison.
null
is handled and returns false
.
null
* @return true
if the specified number occurs within this range
* @throws IllegalArgumentException if the Number
cannot be compared
*/
public abstract boolean containsNumber(Number number);
/**
* Tests whether the specified Number
occurs within
* this range using long
comparison..
null
is handled and returns false
.
This implementation forwards to the {@link #containsLong(long)} method.
* * @param value the long to test, may benull
* @return true
if the specified number occurs within this
* range by long
comparison
*/
public boolean containsLong(Number value) {
if (value == null) {
return false;
}
return containsLong(value.longValue());
}
/**
* Tests whether the specified long
occurs within
* this range using long
comparison.
This implementation uses the {@link #getMinimumLong()} and * {@link #getMaximumLong()} methods and should be good for most uses.
* * @param value the long to test * @returntrue
if the specified number occurs within this
* range by long
comparison
*/
public boolean containsLong(long value) {
return value >= getMinimumLong() && value <= getMaximumLong();
}
/**
* Tests whether the specified Number
occurs within
* this range using int
comparison..
null
is handled and returns false
.
This implementation forwards to the {@link #containsInteger(int)} method.
* * @param value the integer to test, may benull
* @return true
if the specified number occurs within this
* range by int
comparison
*/
public boolean containsInteger(Number value) {
if (value == null) {
return false;
}
return containsInteger(value.intValue());
}
/**
* Tests whether the specified int
occurs within
* this range using int
comparison.
This implementation uses the {@link #getMinimumInteger()} and * {@link #getMaximumInteger()} methods and should be good for most uses.
* * @param value the int to test * @returntrue
if the specified number occurs within this
* range by int
comparison
*/
public boolean containsInteger(int value) {
return value >= getMinimumInteger() && value <= getMaximumInteger();
}
/**
* Tests whether the specified Number
occurs within
* this range using double
comparison..
null
is handled and returns false
.
This implementation forwards to the {@link #containsDouble(double)} method.
* * @param value the double to test, may benull
* @return true
if the specified number occurs within this
* range by double
comparison
*/
public boolean containsDouble(Number value) {
if (value == null) {
return false;
}
return containsDouble(value.doubleValue());
}
/**
* Tests whether the specified double
occurs within
* this range using double
comparison.
This implementation uses the {@link #getMinimumDouble()} and * {@link #getMaximumDouble()} methods and should be good for most uses.
* * @param value the double to test * @returntrue
if the specified number occurs within this
* range by double
comparison
*/
public boolean containsDouble(double value) {
int compareMin = compare(getMinimumDouble(), value);
int compareMax = compare(getMaximumDouble(), value);
return compareMin <= 0 && compareMax >= 0;
}
/**
* Tests whether the specified Number
occurs within
* this range using float
comparison.
null
is handled and returns false
.
This implementation forwards to the {@link #containsFloat(float)} method.
* * @param value the float to test, may benull
* @return true
if the specified number occurs within this
* range by float
comparison
*/
public boolean containsFloat(Number value) {
if (value == null) {
return false;
}
return containsFloat(value.floatValue());
}
/**
* Tests whether the specified float
occurs within
* this range using float
comparison.
This implementation uses the {@link #getMinimumFloat()} and * {@link #getMaximumFloat()} methods and should be good for most uses.
* * @param value the float to test * @returntrue
if the specified number occurs within this
* range by float
comparison
*/
public boolean containsFloat(float value) {
int compareMin = compare(getMinimumFloat(), value);
int compareMax = compare(getMaximumFloat(), value);
return compareMin <= 0 && compareMax >= 0;
}
// Range tests
//--------------------------------------------------------------------
/**
* Tests whether the specified range occurs entirely within this range.
* *The exact comparison implementation varies by subclass. It is
* intended that an int
specific subclass will compare using
* int
comparison.
null
is handled and returns false
.
This implementation uses the {@link #containsNumber(Number)} method. * Subclasses may be able to optimise this.
* * @param range the range to test, may benull
* @return true
if the specified range occurs entirely within
* this range; otherwise, false
* @throws IllegalArgumentException if the Range
cannot be compared
*/
public boolean containsRange(Range range) {
if (range == null) {
return false;
}
return containsNumber(range.getMinimumNumber())
&& containsNumber(range.getMaximumNumber());
}
/**
* Tests whether the specified range overlaps with this range.
* *The exact comparison implementation varies by subclass. It is
* intended that an int
specific subclass will compare using
* int
comparison.
null
is handled and returns false
.
This implementation uses the {@link #containsNumber(Number)} and * {@link #containsRange(Range)} methods. * Subclasses may be able to optimise this.
* * @param range the range to test, may benull
* @return true
if the specified range overlaps with this
* range; otherwise, false
* @throws IllegalArgumentException if the Range
cannot be compared
*/
public boolean overlapsRange(Range range) {
if (range == null) {
return false;
}
return range.containsNumber(getMinimumNumber())
|| range.containsNumber(getMaximumNumber())
|| containsNumber(range.getMinimumNumber());
}
// Basics
//--------------------------------------------------------------------
/**
* Compares this range to another object to test if they are equal.
. * *To be equal, the class, minimum and maximum must be equal.
* *This implementation uses the {@link #getMinimumNumber()} and * {@link #getMaximumNumber()} methods. * Subclasses may be able to optimise this.
* * @param obj the reference object with which to compare * @returntrue
if this object is equal
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
} else if (obj == null || obj.getClass() != getClass()) {
return false;
} else {
Range range = (Range) obj;
return getMinimumNumber().equals(range.getMinimumNumber()) &&
getMaximumNumber().equals(range.getMaximumNumber());
}
}
/**
* Gets a hashCode for the range.
* *This implementation uses the {@link #getMinimumNumber()} and * {@link #getMaximumNumber()} methods. * Subclasses may be able to optimise this.
* * @return a hash code value for this object */ public int hashCode() { int result = 17; result = 37 * result + getClass().hashCode(); result = 37 * result + getMinimumNumber().hashCode(); result = 37 * result + getMaximumNumber().hashCode(); return result; } /** *Gets the range as a String
.
The format of the String is 'Range[min,max]'.
* *This implementation uses the {@link #getMinimumNumber()} and * {@link #getMaximumNumber()} methods. * Subclasses may be able to optimise this.
* * @return theString
representation of this range
*/
public String toString() {
StringBuffer buf = new StringBuffer(32);
buf.append("Range[");
buf.append(getMinimumNumber());
buf.append(',');
buf.append(getMaximumNumber());
buf.append(']');
return buf.toString();
}
/**
* Compares two doubles
for order.
This method is more comprehensive than the standard Java greater * than, less than and equals operators.
*-1
if the first value is less than the second.+1
if the first value is greater than the second.0
if the values are equal.* The ordering is as follows, largest to smallest: *
-Double.MAX_VALUE
)
* Comparing NaN
with NaN
will
* return 0
.
double
* @param rhs the second double
* @return -1
if lhs is less, +1
if greater,
* 0
if equal to rhs
*/
public static int compare(double lhs, double rhs) {
if (lhs < rhs) {
return -1;
}
if (lhs > rhs) {
return +1;
}
// Need to compare bits to handle 0.0 == -0.0 being true
// compare should put -0.0 < +0.0
// Two NaNs are also == for compare purposes
// where NaN == NaN is false
long lhsBits = Double.doubleToLongBits(lhs);
long rhsBits = Double.doubleToLongBits(rhs);
if (lhsBits == rhsBits) {
return 0;
}
// Something exotic! A comparison to NaN or 0.0 vs -0.0
// Fortunately NaN's long is > than everything else
// Also negzeros bits < poszero
// NAN: 9221120237041090560
// MAX: 9218868437227405311
// NEGZERO: -9223372036854775808
if (lhsBits < rhsBits) {
return -1;
} else {
return +1;
}
}
/**
* Compares two floats for order.
* *This method is more comprehensive than the standard Java greater than, * less than and equals operators.
*-1
if the first value is less than the second.
* +1
if the first value is greater than the second.
* 0
if the values are equal.
* The ordering is as follows, largest to smallest: *
-Float.MAX_VALUE
)
* Comparing NaN
with NaN
will return
* 0
.
float
* @param rhs the second float
* @return -1
if lhs is less, +1
if greater,
* 0
if equal to rhs
*/
public static int compare(float lhs, float rhs) {
if (lhs < rhs) {
return -1;
}
if (lhs > rhs) {
return +1;
}
//Need to compare bits to handle 0.0 == -0.0 being true
// compare should put -0.0 < +0.0
// Two NaNs are also == for compare purposes
// where NaN == NaN is false
int lhsBits = Float.floatToIntBits(lhs);
int rhsBits = Float.floatToIntBits(rhs);
if (lhsBits == rhsBits) {
return 0;
}
//Something exotic! A comparison to NaN or 0.0 vs -0.0
//Fortunately NaN's int is > than everything else
//Also negzeros bits < poszero
//NAN: 2143289344
//MAX: 2139095039
//NEGZERO: -2147483648
if (lhsBits < rhsBits) {
return -1;
} else {
return +1;
}
}
}