Class FloatRange
- All Implemented Interfaces:
Serializable
FloatRange
represents an inclusive range of float
s.
- Since:
- 2.0
- Version:
- $Id: FloatRange.java 905636 2010-02-02 14:03:32Z niallp $
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionFloatRange
(float number) Constructs a newFloatRange
using the specified number as both the minimum and maximum in this range.FloatRange
(float number1, float number2) Constructs a newFloatRange
with the specified minimum and maximum numbers (both inclusive).FloatRange
(Number number) Constructs a newFloatRange
using the specified number as both the minimum and maximum in this range.FloatRange
(Number number1, Number number2) Constructs a newFloatRange
with the specified minimum and maximum numbers (both inclusive). -
Method Summary
Modifier and TypeMethodDescriptionboolean
containsFloat
(float value) Tests whether the specifiedfloat
occurs within this range usingfloat
comparison.boolean
containsNumber
(Number number) Tests whether the specifiednumber
occurs within this range usingfloat
comparison.boolean
containsRange
(Range range) Tests whether the specified range occurs entirely within this range usingfloat
comparison.boolean
Compares this range to another object to test if they are equal.double
Gets the maximum number in this range as adouble
.float
Gets the maximum number in this range as afloat
.int
Gets the maximum number in this range as aint
.long
Gets the maximum number in this range as along
.Returns the maximum number in this range.double
Gets the minimum number in this range as adouble
.float
Gets the minimum number in this range as afloat
.int
Gets the minimum number in this range as aint
.long
Gets the minimum number in this range as along
.Returns the minimum number in this range.int
hashCode()
Gets a hashCode for the range.boolean
overlapsRange
(Range range) Tests whether the specified range overlaps with this range usingfloat
comparison.toString()
Gets the range as aString
.Methods inherited from class org.apache.commons.lang.math.Range
containsDouble, containsDouble, containsFloat, containsInteger, containsInteger, containsLong, containsLong
-
Constructor Details
-
FloatRange
public FloatRange(float number) 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 isNaN
-
FloatRange
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 not benull
- Throws:
IllegalArgumentException
- if the number isnull
IllegalArgumentException
- if the number isNaN
-
FloatRange
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). The getMinimum and getMaximum methods will return the correct values.
- Parameters:
number1
- first number that defines the edge of the range, inclusivenumber2
- second number that defines the edge of the range, inclusive- Throws:
IllegalArgumentException
- if either number isNaN
-
FloatRange
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, inclusivenumber2
- second number that defines the edge of the range, inclusive- Throws:
IllegalArgumentException
- if either number isnull
IllegalArgumentException
- if either number isNaN
-
-
Method Details
-
getMinimumNumber
Returns the minimum number in this range.
- Specified by:
getMinimumNumber
in classRange
- Returns:
- the minimum number in this range
-
getMinimumLong
public long getMinimumLong()Gets the minimum number in this range as a
long
.This conversion can lose information for large values or decimals.
- Overrides:
getMinimumLong
in classRange
- Returns:
- the minimum number in this range
-
getMinimumInteger
public int getMinimumInteger()Gets the minimum number in this range as a
int
.This conversion can lose information for large values or decimals.
- Overrides:
getMinimumInteger
in classRange
- Returns:
- the minimum number in this range
-
getMinimumDouble
public double getMinimumDouble()Gets the minimum number in this range as a
double
.- Overrides:
getMinimumDouble
in classRange
- Returns:
- the minimum number in this range
-
getMinimumFloat
public float getMinimumFloat()Gets the minimum number in this range as a
float
.- Overrides:
getMinimumFloat
in classRange
- Returns:
- the minimum number in this range
-
getMaximumNumber
Returns the maximum number in this range.
- Specified by:
getMaximumNumber
in classRange
- Returns:
- the maximum number in this range
-
getMaximumLong
public long getMaximumLong()Gets the maximum number in this range as a
long
.This conversion can lose information for large values or decimals.
- Overrides:
getMaximumLong
in classRange
- Returns:
- the maximum number in this range
-
getMaximumInteger
public int getMaximumInteger()Gets the maximum number in this range as a
int
.This conversion can lose information for large values or decimals.
- Overrides:
getMaximumInteger
in classRange
- Returns:
- the maximum number in this range
-
getMaximumDouble
public double getMaximumDouble()Gets the maximum number in this range as a
double
.- Overrides:
getMaximumDouble
in classRange
- Returns:
- the maximum number in this range
-
getMaximumFloat
public float getMaximumFloat()Gets the maximum number in this range as a
float
.- Overrides:
getMaximumFloat
in classRange
- Returns:
- the maximum number in this range
-
containsNumber
Tests whether the specified
number
occurs within this range usingfloat
comparison.null
is handled and returnsfalse
.- Specified by:
containsNumber
in classRange
- Parameters:
number
- the number to test, may benull
- Returns:
true
if the specified number occurs within this range
-
containsFloat
public boolean containsFloat(float value) Tests whether the specified
float
occurs within this range usingfloat
comparison.This implementation overrides the superclass for performance as it is the most common case.
- Overrides:
containsFloat
in classRange
- Parameters:
value
- the float to test- Returns:
true
if the specified number occurs within this range byfloat
comparison
-
containsRange
Tests whether the specified range occurs entirely within this range using
float
comparison.null
is handled and returnsfalse
.- Overrides:
containsRange
in classRange
- Parameters:
range
- the range to test, may benull
- Returns:
true
if the specified range occurs entirely within this range- Throws:
IllegalArgumentException
- if the range is not of this type
-
overlapsRange
Tests whether the specified range overlaps with this range using
float
comparison.null
is handled and returnsfalse
.- Overrides:
overlapsRange
in classRange
- Parameters:
range
- the range to test, may benull
- Returns:
true
if the specified range overlaps with this range
-
equals
Compares this range to another object to test if they are equal.
.To be equal, the class, minimum and maximum must be equal.
-
hashCode
public int hashCode()Gets a hashCode for the range.
-
toString
Gets the range as a
String
.The format of the String is 'Range[min,max]'.
-