|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.lang.math.Range org.apache.commons.lang.math.FloatRange
public final class FloatRange
FloatRange
represents an inclusive range of float
s.
Constructor Summary | |
---|---|
FloatRange(float number)
Constructs a new FloatRange using the specified
number as both the minimum and maximum in this range. |
|
FloatRange(float number1,
float number2)
Constructs a new FloatRange with the specified
minimum and maximum numbers (both inclusive). |
|
FloatRange(Number number)
Constructs a new FloatRange using the specified
number as both the minimum and maximum in this range. |
|
FloatRange(Number number1,
Number number2)
Constructs a new FloatRange with the specified
minimum and maximum numbers (both inclusive). |
Method Summary | |
---|---|
boolean |
containsFloat(float value)
Tests whether the specified float occurs within
this range using float comparison. |
boolean |
containsNumber(Number number)
Tests whether the specified number occurs within
this range using float comparison. |
boolean |
containsRange(Range range)
Tests whether the specified range occurs entirely within this range using float comparison. |
boolean |
equals(Object obj)
Compares this range to another object to test if they are equal. |
double |
getMaximumDouble()
Gets the maximum number in this range as a double . |
float |
getMaximumFloat()
Gets the maximum number in this range as a float . |
int |
getMaximumInteger()
Gets the maximum number in this range as a int . |
long |
getMaximumLong()
Gets the maximum number in this range as a long . |
Number |
getMaximumNumber()
Returns the maximum number in this range. |
double |
getMinimumDouble()
Gets the minimum number in this range as a double . |
float |
getMinimumFloat()
Gets the minimum number in this range as a float . |
int |
getMinimumInteger()
Gets the minimum number in this range as a int . |
long |
getMinimumLong()
Gets the minimum number in this range as a long . |
Number |
getMinimumNumber()
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 using float comparison. |
String |
toString()
Gets the range as a String . |
Methods inherited from class org.apache.commons.lang.math.Range |
---|
containsDouble, containsDouble, containsFloat, containsInteger, containsInteger, containsLong, containsLong |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FloatRange(float number)
Constructs a new FloatRange
using the specified
number as both the minimum and maximum in this range.
number
- the number to use for this range
IllegalArgumentException
- if the number is NaN
public FloatRange(Number number)
Constructs a new FloatRange
using the specified
number as both the minimum and maximum in this range.
number
- the number to use for this range, must not
be null
IllegalArgumentException
- if the number is null
IllegalArgumentException
- if the number is NaN
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.
number1
- first number that defines the edge of the range, inclusivenumber2
- second number that defines the edge of the range, inclusive
IllegalArgumentException
- if either number is NaN
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). The getMinimum and getMaximum methods will return the correct values.
number1
- first number that defines the edge of the range, inclusivenumber2
- second number that defines the edge of the range, inclusive
IllegalArgumentException
- if either number is null
IllegalArgumentException
- if either number is NaN
Method Detail |
---|
public Number getMinimumNumber()
Returns the minimum number in this range.
getMinimumNumber
in class Range
public long getMinimumLong()
Gets the minimum number in this range as a long
.
This conversion can lose information for large values or decimals.
getMinimumLong
in class Range
public int getMinimumInteger()
Gets the minimum number in this range as a int
.
This conversion can lose information for large values or decimals.
getMinimumInteger
in class Range
public double getMinimumDouble()
Gets the minimum number in this range as a double
.
getMinimumDouble
in class Range
public float getMinimumFloat()
Gets the minimum number in this range as a float
.
getMinimumFloat
in class Range
public Number getMaximumNumber()
Returns the maximum number in this range.
getMaximumNumber
in class Range
public long getMaximumLong()
Gets the maximum number in this range as a long
.
This conversion can lose information for large values or decimals.
getMaximumLong
in class Range
public int getMaximumInteger()
Gets the maximum number in this range as a int
.
This conversion can lose information for large values or decimals.
getMaximumInteger
in class Range
public double getMaximumDouble()
Gets the maximum number in this range as a double
.
getMaximumDouble
in class Range
public float getMaximumFloat()
Gets the maximum number in this range as a float
.
getMaximumFloat
in class Range
public boolean containsNumber(Number number)
Tests whether the specified number
occurs within
this range using float
comparison.
null
is handled and returns false
.
containsNumber
in class Range
number
- the number to test, may be null
true
if the specified number occurs within this rangepublic boolean containsFloat(float value)
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.
containsFloat
in class Range
value
- the float to test
true
if the specified number occurs within this
range by float
comparisonpublic boolean containsRange(Range range)
Tests whether the specified range occurs entirely within this range
using float
comparison.
null
is handled and returns false
.
containsRange
in class Range
range
- the range to test, may be null
true
if the specified range occurs entirely within this range
IllegalArgumentException
- if the range is not of this typepublic boolean overlapsRange(Range range)
Tests whether the specified range overlaps with this range
using float
comparison.
null
is handled and returns false
.
overlapsRange
in class Range
range
- the range to test, may be null
true
if the specified range overlaps with this rangepublic boolean equals(Object obj)
Compares this range to another object to test if they are equal.
.To be equal, the class, minimum and maximum must be equal.
equals
in class Range
obj
- the reference object with which to compare
true
if this object is equalpublic int hashCode()
Gets a hashCode for the range.
hashCode
in class Range
public String toString()
Gets the range as a String
.
The format of the String is 'Range[min,max]'.
toString
in class Range
String
representation of this range
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |