|
||||||||||
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.LongRange
public final class LongRange
LongRange
represents an inclusive range of long
s.
Constructor Summary | |
---|---|
LongRange(long number)
Constructs a new LongRange using the specified
number as both the minimum and maximum in this range. |
|
LongRange(long number1,
long number2)
Constructs a new LongRange with the specified
minimum and maximum numbers (both inclusive). |
|
LongRange(Number number)
Constructs a new LongRange using the specified
number as both the minimum and maximum in this range. |
|
LongRange(Number number1,
Number number2)
Constructs a new LongRange with the specified
minimum and maximum numbers (both inclusive). |
Method Summary | |
---|---|
boolean |
containsLong(long value)
Tests whether the specified long occurs within
this range using long comparison. |
boolean |
containsNumber(Number number)
Tests whether the specified number occurs within
this range using long comparison. |
boolean |
containsRange(Range range)
Tests whether the specified range occurs entirely within this range using long 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 cast to an 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 long comparison. |
String |
toString()
Gets the range as a String . |
Methods inherited from class org.apache.commons.lang.math.Range |
---|
containsDouble, containsDouble, containsFloat, containsFloat, containsInteger, containsInteger, containsLong |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LongRange(long number)
Constructs a new LongRange
using the specified
number as both the minimum and maximum in this range.
number
- the number to use for this rangepublic LongRange(Number number)
Constructs a new LongRange
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
public LongRange(long number1, long number2)
Constructs a new LongRange
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, inclusivepublic LongRange(Number number1, Number number2)
Constructs a new LongRange
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
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
.
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.
getMinimumInteger
in class Range
public double getMinimumDouble()
Gets the minimum number in this range as a double
.
This conversion can lose information for large values.
getMinimumDouble
in class Range
public float getMinimumFloat()
Gets the minimum number in this range as a float
.
This conversion can lose information for large values.
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
.
getMaximumLong
in class Range
public int getMaximumInteger()
Gets the maximum number in this range cast to an int
.
This conversion can lose information for large values.
getMaximumInteger
in class Range
int
.public double getMaximumDouble()
Gets the maximum number in this range as a double
.
This conversion can lose information for large values.
getMaximumDouble
in class Range
double
.public float getMaximumFloat()
Gets the maximum number in this range as a float
.
This conversion can lose information for large values.
getMaximumFloat
in class Range
float
.public boolean containsNumber(Number number)
Tests whether the specified number
occurs within
this range using long
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 containsLong(long value)
Tests whether the specified long
occurs within
this range using long
comparison.
This implementation overrides the superclass for performance as it is the most common case.
containsLong
in class Range
value
- the long to test
true
if the specified number occurs within this
range by long
comparisonpublic boolean containsRange(Range range)
Tests whether the specified range occurs entirely within this range
using long
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 long
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 |