| java.lang.Object
 org.apache.commons.lang.math.Range
org.apache.commons.lang.math.FloatRange
| FloatRange | | final public class FloatRange extends Range implements Serializable(Code) | | FloatRange represents an inclusive range of floats.
author:
Stephen Colebourne
since:
2.0
version:
$Id: FloatRange.java 437554 2006-08-28 06:21:41Z bayard $ |
| Constructor Summary | |
| public | FloatRange(float number)
| | public | FloatRange(Number number)
| | public | FloatRange(float number1, float number2)
Constructs a new FloatRange with the specified
minimum and maximum numbers (both inclusive).
The arguments may be passed in the order (min,max) or (max,min). | | public | FloatRange(Number number1, Number number2)
Constructs a new FloatRange with the specified
minimum and maximum numbers (both inclusive).
The arguments may be passed in the order (min,max) or (max,min). |
| FloatRange | | public FloatRange(float number)(Code) | | Constructs a new FloatRange using the specified
number as both the minimum and maximum in this range.
Parameters:
number - the number to use for this range
throws:
IllegalArgumentException - if the number is NaN |
| FloatRange | | public FloatRange(Number number)(Code) | | Constructs a new FloatRange using the specified
number as both the minimum and maximum in this range.
Parameters:
number - the number to use for this range, must notbe null
throws:
IllegalArgumentException - if the number is null
throws:
IllegalArgumentException - if the number is NaN |
| FloatRange | | public FloatRange(float number1, float number2)(Code) | | Constructs a new FloatRange 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.
Parameters:
number1 - first number that defines the edge of the range, inclusive
Parameters:
number2 - second number that defines the edge of the range, inclusive
throws:
IllegalArgumentException - if either number is NaN |
| FloatRange | | public FloatRange(Number number1, Number number2)(Code) | | Constructs a new FloatRange 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.
Parameters:
number1 - first number that defines the edge of the range, inclusive
Parameters:
number2 - second number that defines the edge of the range, inclusive
throws:
IllegalArgumentException - if either number is null
throws:
IllegalArgumentException - if either number is NaN |
| containsFloat | | public boolean containsFloat(float value)(Code) | | Tests whether the specified float occurs within
this range using float comparison.
This implementation overrides the superclass for performance as it is
the most common case.
Parameters:
value - the float to test true if the specified number occurs within thisrange by float comparison |
| containsNumber | | public boolean containsNumber(Number number)(Code) | | Tests whether the specified number occurs within
this range using float comparison.
null is handled and returns false.
Parameters:
number - the number to test, may be null true if the specified number occurs within this range |
| containsRange | | public boolean containsRange(Range range)(Code) | | Tests whether the specified range occurs entirely within this range
using float comparison.
null is handled and returns false.
Parameters:
range - the range to test, may be null true if the specified range occurs entirely within this range
throws:
IllegalArgumentException - if the range is not of this type |
| equals | | public boolean equals(Object obj)(Code) | | Compares this range to another object to test if they are equal. .
To be equal, the class, minimum and maximum must be equal.
Parameters:
obj - the reference object with which to compare true if this object is equal |
| getMaximumDouble | | public double getMaximumDouble()(Code) | | Gets the maximum number in this range as a double.
the maximum number in this range |
| getMaximumFloat | | public float getMaximumFloat()(Code) | | Gets the maximum number in this range as a float.
the maximum number in this range |
| getMaximumInteger | | public int getMaximumInteger()(Code) | | Gets the maximum number in this range as a int.
This conversion can lose information for large values or decimals.
the maximum number in this range |
| getMaximumLong | | public long getMaximumLong()(Code) | | Gets the maximum number in this range as a long.
This conversion can lose information for large values or decimals.
the maximum number in this range |
| getMaximumNumber | | public Number getMaximumNumber()(Code) | | Returns the maximum number in this range.
the maximum number in this range |
| getMinimumDouble | | public double getMinimumDouble()(Code) | | Gets the minimum number in this range as a double.
the minimum number in this range |
| getMinimumFloat | | public float getMinimumFloat()(Code) | | Gets the minimum number in this range as a float.
the minimum number in this range |
| getMinimumInteger | | public int getMinimumInteger()(Code) | | Gets the minimum number in this range as a int.
This conversion can lose information for large values or decimals.
the minimum number in this range |
| getMinimumLong | | public long getMinimumLong()(Code) | | Gets the minimum number in this range as a long.
This conversion can lose information for large values or decimals.
the minimum number in this range |
| getMinimumNumber | | public Number getMinimumNumber()(Code) | | Returns the minimum number in this range.
the minimum number in this range |
| hashCode | | public int hashCode()(Code) | | Gets a hashCode for the range.
a hash code value for this object |
| overlapsRange | | public boolean overlapsRange(Range range)(Code) | | Tests whether the specified range overlaps with this range
using float comparison.
null is handled and returns false.
Parameters:
range - the range to test, may be null true if the specified range overlaps with this range |
| toString | | public String toString()(Code) | | Gets the range as a String.
The format of the String is 'Range[min,max]'.
the String representation of this range |
|
|