org.apache.commons.lang.math

Class IntRange

public final class IntRange extends Range implements Serializable

IntRange represents an inclusive range of ints.

Since: 2.0

Version: $Id: IntRange.java 437554 2006-08-28 06:21:41Z bayard $

Author: Stephen Colebourne

Constructor Summary
IntRange(int number)

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

IntRange(Number number)

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

IntRange(int number1, int number2)

Constructs a new IntRange with the specified minimum and maximum numbers (both inclusive).

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

IntRange(Number number1, Number number2)

Constructs a new IntRange with the specified minimum and maximum numbers (both inclusive).

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

Method Summary
booleancontainsInteger(int value)

Tests whether the specified int occurs within this range using int 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 int comparison.

null is handled and returns false.

booleancontainsRange(Range range)

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

floatgetMaximumFloat()

Gets the maximum number in this range as a float.

intgetMaximumInteger()

Gets the maximum number in this range as a int.

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.

floatgetMinimumFloat()

Gets the minimum number in this range as a float.

intgetMinimumInteger()

Gets the minimum number in this range as a int.

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 int 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

IntRange

public IntRange(int number)

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

Parameters: number the number to use for this range

IntRange

public IntRange(Number number)

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

IntRange

public IntRange(int number1, int number2)

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

IntRange

public IntRange(Number number1, Number number2)

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

containsInteger

public boolean containsInteger(int value)

Tests whether the specified int occurs within this range using int comparison.

This implementation overrides the superclass for performance as it is the most common case.

Parameters: value the int to test

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

containsNumber

public boolean containsNumber(Number number)

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

Returns: the maximum number in this range

getMaximumFloat

public float getMaximumFloat()

Gets the maximum number in this range as a float.

Returns: the maximum number in this range

getMaximumInteger

public int getMaximumInteger()

Gets the maximum number in this range as a int.

Returns: the maximum number in this range

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.

Returns: the minimum number in this range

getMinimumFloat

public float getMinimumFloat()

Gets the minimum number in this range as a float.

Returns: the minimum number in this range

getMinimumInteger

public int getMinimumInteger()

Gets the minimum number in this range as a int.

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 int 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