Class NumberRange<N extends Number>

java.lang.Object

org.apache.commons.lang3.Range<N>

org.apache.commons.lang3.NumberRange<N>

Type Parameters:

N - The Number class.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DoubleRange, IntegerRange, LongRange

public class NumberRange<N extends Number>
extends Range<N>

Specializes Range for Numbers.

We only offer specializations for Integer, Long, and Double (like Java Streams).

Since:

3.13.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NumberRange(N number1, N number2, Comparator<N> comp)	Creates an instance.

Method Summary

Methods inherited from class Range

between, between, contains, containsRange, elementCompareTo, equals, fit, getComparator, getMaximum, getMinimum, hashCode, intersectionWith, is, is, isAfter, isAfterRange, isBefore, isBeforeRange, isEndedBy, isNaturalOrdering, isOverlappedBy, isStartedBy, of, of, toString, toString

Modifier and Type	Method	Description
static <T extends Comparable<? super T>> Range<T>	between(T fromInclusive, T toInclusive)	Deprecated. Use Range.of(Comparable, Comparable).
static <T> Range<T>	between(T fromInclusive, T toInclusive, Comparator<T> comparator)	Deprecated. Use Range.of(Object, Object, Comparator).
boolean	contains(N element)	Checks whether the specified element occurs within this range.
boolean	containsRange(Range<N> otherRange)	Checks whether this range contains all the elements of the specified range.
int	elementCompareTo(N element)	Checks where the specified element occurs relative to this range.
boolean	equals(Object obj)	Compares this range to another object to test if they are equal.
N	fit(N element)	Fits the given element into this range by returning the given element or, if out of bounds, the range minimum if below, or the range maximum if above.
Comparator<N>	getComparator()	Gets the comparator being used to determine if objects are within the range.
N	getMaximum()	Gets the maximum value in this range.
N	getMinimum()	Gets the minimum value in this range.
int	hashCode()	Gets a suitable hash code for the range.
Range<N>	intersectionWith(Range<N> other)	Calculate the intersection of this and an overlapping Range.
static <T extends Comparable<? super T>> Range<T>	is(T element)	Creates a range using the specified element as both the minimum and maximum in this range.
static <T> Range<T>	is(T element, Comparator<T> comparator)	Creates a range using the specified element as both the minimum and maximum in this range.
boolean	isAfter(N element)	Tests whether this range is after the specified element.
boolean	isAfterRange(Range<N> otherRange)	Tests whether this range is completely after the specified range.
boolean	isBefore(N element)	Tests whether this range is before the specified element.
boolean	isBeforeRange(Range<N> otherRange)	Tests whether this range is completely before the specified range.
boolean	isEndedBy(N element)	Tests whether this range ends with the specified element.
boolean	isNaturalOrdering()	Tests whether or not the Range is using the natural ordering of the elements.
boolean	isOverlappedBy(Range<N> otherRange)	Tests whether this range is overlapped by the specified range.
boolean	isStartedBy(N element)	Tests whether this range starts with the specified element.
static <T extends Comparable<? super T>> Range<T>	of(T fromInclusive, T toInclusive)	Creates a range with the specified minimum and maximum values (both inclusive).
static <T> Range<T>	of(T fromInclusive, T toInclusive, Comparator<T> comparator)	Creates a range with the specified minimum and maximum values (both inclusive).
String	toString()	Gets the range as a String.
String	toString(String format)	Formats the receiver using the given format.

Methods inherited from class Object

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

Constructor Details

NumberRange

public NumberRange(N number1,
 N number2,
 Comparator<N> comp)

Creates an instance.

Parameters:

number1 - The first element, not null.

number2 - The second element, not null.

comp - The comparator to be used, null for natural ordering.

Throws:

NullPointerException - Thrown when element1 is null.

NullPointerException - Thrown when element2 is null.

IllegalArgumentException - Thrown when element1 or element2 is a floating-point NaN.