org.apache.commons.lang.math
クラス NumberRange

java.lang.Object
  org.apache.commons.lang.math.Range
      org.apache.commons.lang.math.NumberRange

すべての実装インタフェース:

Serializable

public final class NumberRange

extends Range

implements Serializable

NumberRange represents an inclusive range of Number objects of the same type.

導入されたバージョン:

2.0 (previously in org.apache.commons.lang)

バージョン:

$Id: NumberRange.java,v 1.1.1.1 2004/02/13 10:02:05 hioki Exp $

作成者:

Christopher Elkins, Stephen Colebourne

関連項目:

直列化された形式

コンストラクタの概要

NumberRange(Number num)
Constructs a new NumberRange using the specified number as both the minimum and maximum in this range.

NumberRange(Number num1, Number num2)
Constructs a new NumberRange with the specified minimum and maximum numbers (both inclusive).

メソッドの概要

boolean	containsNumber(Number number) Tests whether the specified number occurs within this range.
boolean	equals(Object obj) Compares this range to another object to test if they are equal.
Number	getMaximumNumber() Returns the maximum number in this range.
Number	getMinimumNumber() Returns the minimum number in this range.
int	hashCode() Gets a hashCode for the range.
String	toString() Gets the range as a String.

クラス org.apache.commons.lang.math.Range から継承したメソッド

containsDouble, containsDouble, containsFloat, containsFloat, containsInteger, containsInteger, containsLong, containsLong, containsRange, getMaximumDouble, getMaximumFloat, getMaximumInteger, getMaximumLong, getMinimumDouble, getMinimumFloat, getMinimumInteger, getMinimumLong, overlapsRange

クラス java.lang.Object から継承したメソッド

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

NumberRange

public NumberRange(Number num)

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

パラメータ:

num - the number to use for this range

例外:

IllegalArgumentException - if the number is null

IllegalArgumentException - if the number doesn't implement Comparable

IllegalArgumentException - if the number is Double.NaN or Float.NaN

NumberRange

public NumberRange(Number num1,
                   Number num2)

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

The arguments may be passed in the order (min,max) or (max,min). The getMinimumNumber() and getMaximumNumber() methods will return the correct value.

This constructor is designed to be used with two Number objects of the same type. If two objects of different types are passed in, an exception is thrown.

パラメータ:

num1 - first number that defines the edge of the range, inclusive

num2 - second number that defines the edge of the range, inclusive

例外:

IllegalArgumentException - if either number is null

IllegalArgumentException - if the numbers are of different types

IllegalArgumentException - if the numbers don't implement Comparable

メソッドの詳細

getMinimumNumber

public Number getMinimumNumber()

Returns the minimum number in this range.

定義:

クラス Range 内の getMinimumNumber

戻り値:

the minimum number in this range

getMaximumNumber

public Number getMaximumNumber()

Returns the maximum number in this range.

定義:

クラス Range 内の getMaximumNumber

戻り値:

the maximum number in this range

containsNumber

public boolean containsNumber(Number number)

Tests whether the specified number occurs within this range.

null is handled and returns false.

定義:

クラス Range 内の containsNumber

パラメータ:

number - the number to test, may be null

戻り値:

true if the specified number occurs within this range

例外:

IllegalArgumentException - if the number is of a different type to the range

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.

オーバーライド:

クラス Range 内の equals

パラメータ:

obj - the reference object with which to compare

戻り値:

true if this object is equal

hashCode

public int hashCode()

Gets a hashCode for the range.

オーバーライド:

クラス Range 内の hashCode

戻り値:

a hash code value for this object

toString

public String toString()

Gets the range as a String.

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

オーバーライド:

クラス Range 内の toString

戻り値:

the String representation of this range