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