org.apache.commons.lang.math

Class LongRange

public final class LongRange extends Range implements Serializable

LongRange represents an inclusive range of longs.

Since: 2.0

Version: $Id: LongRange.java 161243 2005-04-14 04:30:28Z ggregory $

Author: Stephen Colebourne

Constructor Summary
LongRange(long number)

Constructs a new LongRange using the specified number as both the minimum and maximum in this range.

LongRange(Number 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).

The arguments may be passed in the order (min,max) or (max,min).

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).

Method Summary
booleancontainsLong(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.

booleancontainsNumber(Number number)

Tests whether the specified number occurs within this range using long comparison.

null is handled and returns false.

booleancontainsRange(Range range)

Tests whether the specified range occurs entirely within this range using long comparison.

null is handled and returns false.

booleanequals(Object obj)

Compares this range to another object to test if they are equal.

.
doublegetMaximumDouble()

Gets the maximum number in this range as a double.

This conversion can lose information for large values.

floatgetMaximumFloat()

Gets the maximum number in this range as a float.

This conversion can lose information for large values.

intgetMaximumInteger()

Gets the maximum number in this range cast to an int.

This conversion can lose information for large values.

longgetMaximumLong()

Gets the maximum number in this range as a long.

NumbergetMaximumNumber()

Returns the maximum number in this range.

doublegetMinimumDouble()

Gets the minimum number in this range as a double.

This conversion can lose information for large values.

floatgetMinimumFloat()

Gets the minimum number in this range as a float.

This conversion can lose information for large values.

intgetMinimumInteger()

Gets the minimum number in this range as a int.

This conversion can lose information for large values.

longgetMinimumLong()

Gets the minimum number in this range as a long.

NumbergetMinimumNumber()

Returns the minimum number in this range.

inthashCode()

Gets a hashCode for the range.

booleanoverlapsRange(Range range)

Tests whether the specified range overlaps with this range using long comparison.

null is handled and returns false.

StringtoString()

Gets the range as a String.

The format of the String is 'Range[min,max]'.

Constructor Detail

LongRange

public LongRange(long number)

Constructs a new LongRange using the specified number as both the minimum and maximum in this range.

Parameters: number the number to use for this range

LongRange

public LongRange(Number number)

Constructs a new LongRange 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

LongRange

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.

Parameters: number1 first number that defines the edge of the range, inclusive number2 second number that defines the edge of the range, inclusive

LongRange

public 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.

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

Method Detail

containsLong

public 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.

Parameters: value the long to test

Returns: true if the specified number occurs within this range by long comparison

containsNumber

public boolean containsNumber(Number number)

Tests whether the specified number occurs within this range using long 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

containsRange

public boolean containsRange(Range range)

Tests whether the specified range occurs entirely within this range using long 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

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.

Parameters: obj the reference object with which to compare

Returns: true if this object is equal

getMaximumDouble

public double getMaximumDouble()

Gets the maximum number in this range as a double.

This conversion can lose information for large values.

Returns: The maximum number in this range as a double.

getMaximumFloat

public float getMaximumFloat()

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 as a float.

getMaximumInteger

public int getMaximumInteger()

Gets the maximum number in this range cast to an int.

This conversion can lose information for large values.

Returns: the maximum number in this range cast to an int.

getMaximumLong

public long getMaximumLong()

Gets the maximum number in this range as a long.

Returns: the maximum number in this range

getMaximumNumber

public Number getMaximumNumber()

Returns the maximum number in this range.

Returns: the maximum number in this range

getMinimumDouble

public double getMinimumDouble()

Gets the minimum number in this range as a double.

This conversion can lose information for large values.

Returns: the minimum number in this range

getMinimumFloat

public float getMinimumFloat()

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

getMinimumInteger

public int getMinimumInteger()

Gets the minimum number in this range as a int.

This conversion can lose information for large values.

Returns: the minimum number in this range

getMinimumLong

public long getMinimumLong()

Gets the minimum number in this range as a long.

Returns: the minimum number in this range

getMinimumNumber

public Number getMinimumNumber()

Returns the minimum number in this range.

Returns: the minimum number in this range

hashCode

public int hashCode()

Gets a hashCode for the range.

Returns: a hash code value for this object

overlapsRange

public boolean overlapsRange(Range range)

Tests whether the specified range overlaps with this range using long 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

toString

public String toString()

Gets the range as a String.

The format of the String is 'Range[min,max]'.

Returns: the String representation of this range

Copyright © 2001-2005 - Apache Software Foundation