org.apache.commons.lang.math
Class FloatRange
- Serializable
public final class FloatRange
implements Serializable
FloatRange
represents an inclusive range of float
s.
$Id: FloatRange.java 161243 2005-04-14 04:30:28Z ggregory $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).
|
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).
|
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 .
|
containsDouble , containsDouble , containsFloat , containsFloat , containsInteger , containsInteger , containsLong , containsLong , containsNumber , containsRange , equals , getMaximumDouble , getMaximumFloat , getMaximumInteger , getMaximumLong , getMaximumNumber , getMinimumDouble , getMinimumFloat , getMinimumInteger , getMinimumLong , getMinimumNumber , hashCode , overlapsRange , toString |
FloatRange
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
FloatRange
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
FloatRange
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
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.
number1
- first number that defines the edge of the range, inclusivenumber2
- second number that defines the edge of the range, inclusive
containsFloat
public 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 interface Range
value
- the float to test
true
if the specified number occurs within this
range by float
comparison
containsNumber
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 interface Range
number
- the number to test, may be null
true
if the specified number occurs within this range
containsRange
public 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 interface Range
range
- the range to test, may be null
true
if the specified range occurs entirely within this range
equals
public 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 interface Range
obj
- the reference object with which to compare
true
if this object is equal
getMaximumDouble
public double getMaximumDouble()
Gets the maximum number in this range as a double
.
- getMaximumDouble in interface Range
- the maximum number in this range
getMaximumFloat
public float getMaximumFloat()
Gets the maximum number in this range as a float
.
- getMaximumFloat in interface Range
- 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.
- getMaximumInteger in interface Range
- 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.
- getMaximumLong in interface Range
- the maximum number in this range
getMaximumNumber
public Number getMaximumNumber()
Returns the maximum number in this range.
- getMaximumNumber in interface Range
- the maximum number in this range
getMinimumDouble
public double getMinimumDouble()
Gets the minimum number in this range as a double
.
- getMinimumDouble in interface Range
- the minimum number in this range
getMinimumFloat
public float getMinimumFloat()
Gets the minimum number in this range as a float
.
- getMinimumFloat in interface Range
- 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.
- getMinimumInteger in interface Range
- 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.
- getMinimumLong in interface Range
- the minimum number in this range
getMinimumNumber
public Number getMinimumNumber()
Returns the minimum number in this range.
- getMinimumNumber in interface Range
- the minimum number in this range
hashCode
public int hashCode()
Gets a hashCode for the range.
- hashCode in interface Range
- a hash code value for this object
overlapsRange
public boolean overlapsRange(Range range)
Tests whether the specified range overlaps with this range
using
float
comparison.
null
is handled and returns
false
.
- overlapsRange in interface Range
range
- the range to test, may be null
true
if the specified range overlaps with this range
toString
public String toString()
Gets the range as a
String
.
The format of the String is 'Range[
min,
max]'.
- toString in interface Range
- the
String
representation of this range
Copyright © 2001-2005 - Apache Software Foundation