|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.lang.math.Range
org.apache.commons.lang.math.DoubleRange
public final class DoubleRange
DoubleRange represents an inclusive range of doubles.
| Constructor Summary | |
|---|---|
DoubleRange(double number)
Constructs a new DoubleRange using the specified
number as both the minimum and maximum in this range. |
|
DoubleRange(double number1,
double number2)
Constructs a new DoubleRange with the specified
minimum and maximum numbers (both inclusive). |
|
DoubleRange(Number number)
Constructs a new DoubleRange using the specified
number as both the minimum and maximum in this range. |
|
DoubleRange(Number number1,
Number number2)
Constructs a new DoubleRange with the specified
minimum and maximum numbers (both inclusive). |
|
| Method Summary | |
|---|---|
boolean |
containsDouble(double value)
Tests whether the specified double occurs within
this range using double comparison. |
boolean |
containsNumber(Number number)
Tests whether the specified number occurs within
this range using double comparison. |
boolean |
containsRange(Range range)
Tests whether the specified range occurs entirely within this range using double 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 double comparison. |
String |
toString()
Gets the range as a String. |
| Methods inherited from class org.apache.commons.lang.math.Range |
|---|
containsDouble, containsFloat, containsFloat, containsInteger, containsInteger, containsLong, containsLong |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public DoubleRange(double number)
Constructs a new DoubleRange 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 NaNpublic DoubleRange(Number number)
Constructs a new DoubleRange 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 DoubleRange(double number1,
double number2)
Constructs a new DoubleRange 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 DoubleRange(Number number1,
Number number2)
Constructs a new DoubleRange 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 Rangepublic 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 Rangepublic 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 Rangepublic double getMinimumDouble()
Gets the minimum number in this range as a double.
getMinimumDouble in class Rangepublic float getMinimumFloat()
Gets the minimum number in this range as a float.
This conversion can lose information for large values.
getMinimumFloat in class Rangepublic Number getMaximumNumber()
Returns the maximum number in this range.
getMaximumNumber in class Rangepublic 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 Rangepublic 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 Rangepublic double getMaximumDouble()
Gets the maximum number in this range as a double.
getMaximumDouble in class Rangepublic float getMaximumFloat()
Gets the maximum number in this range as a float.
This conversion can lose information for large values.
getMaximumFloat in class Rangepublic boolean containsNumber(Number number)
Tests whether the specified number occurs within
this range using double comparison.
null is handled and returns false.
containsNumber in class Rangenumber - the number to test, may be null
true if the specified number occurs within this rangepublic boolean containsDouble(double value)
Tests whether the specified double occurs within
this range using double comparison.
This implementation overrides the superclass for performance as it is the most common case.
containsDouble in class Rangevalue - the double to test
true if the specified number occurs within this
range by double comparisonpublic boolean containsRange(Range range)
Tests whether the specified range occurs entirely within this range
using double comparison.
null is handled and returns false.
containsRange in class Rangerange - 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 double comparison.
null is handled and returns false.
overlapsRange in class Rangerange - 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 Rangeobj - the reference object with which to compare
true if this object is equalpublic int hashCode()
Gets a hashCode for the range.
hashCode in class Rangepublic String toString()
Gets the range as a String.
The format of the String is 'Range[min,max]'.
toString in class RangeString representation of this range
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||