Class IntegerRange

java.lang.Object

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

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

org.apache.commons.lang3.IntegerRange

All Implemented Interfaces:

Serializable

public final class IntegerRange
extends NumberRange<Integer>

Specializes NumberRange for Integers.

This class is not designed to interoperate with other NumberRanges

Since:

3.13.0

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
int	fit(int element)	Fits the given value into this range by returning the given value or, if out of bounds, the range minimum if below, or the range maximum if above.
static IntegerRange	of(int fromInclusive, int toInclusive)	Creates a closed range with the specified minimum and maximum values (both inclusive).
static IntegerRange	of(Integer fromInclusive, Integer toInclusive)	Creates a closed range with the specified minimum and maximum values (both inclusive).
IntStream	toIntStream()	Returns a sequential ordered IntStream from Range.getMinimum() (inclusive) to Range.getMaximum() (inclusive) by an incremental step of 1.

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(Integer element)	Checks whether the specified element occurs within this range.
boolean	containsRange(Range<Integer> otherRange)	Checks whether this range contains all the elements of the specified range.
int	elementCompareTo(Integer 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.
Integer	fit(Integer 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<Integer>	getComparator()	Gets the comparator being used to determine if objects are within the range.
Integer	getMaximum()	Gets the maximum value in this range.
Integer	getMinimum()	Gets the minimum value in this range.
int	hashCode()	Gets a suitable hash code for the range.
Range<Integer>	intersectionWith(Range<Integer> 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(Integer element)	Tests whether this range is after the specified element.
boolean	isAfterRange(Range<Integer> otherRange)	Tests whether this range is completely after the specified range.
boolean	isBefore(Integer element)	Tests whether this range is before the specified element.
boolean	isBeforeRange(Range<Integer> otherRange)	Tests whether this range is completely before the specified range.
boolean	isEndedBy(Integer 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<Integer> otherRange)	Tests whether this range is overlapped by the specified range.
boolean	isStartedBy(Integer 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

Method Details

of

public static IntegerRange of(int fromInclusive,
 int toInclusive)

Creates a closed range with the specified minimum and maximum values (both inclusive).

The range uses the natural ordering of the elements to determine where values lie in the range.

The arguments may be passed in the order (min, max) or (max,min). The getMinimum and getMaximum methods will return the correct values.

Parameters:

fromInclusive - The first value that defines the edge of the range, inclusive.

toInclusive - The second value that defines the edge of the range, inclusive.

Returns:

The range object, not null.

of

public static IntegerRange of(Integer fromInclusive,
 Integer toInclusive)

Creates a closed range with the specified minimum and maximum values (both inclusive).

The range uses the natural ordering of the elements to determine where values lie in the range.

The arguments may be passed in the order (min, max) or (max,min). The getMinimum and getMaximum methods will return the correct values.

Parameters:

fromInclusive - The first value that defines the edge of the range, inclusive.

toInclusive - The second value that defines the edge of the range, inclusive.

Returns:

The range object, not null.

Throws:

NullPointerException - Thrown if either element is null.

fit

public int fit(int element)

Fits the given value into this range by returning the given value or, if out of bounds, the range minimum if below, or the range maximum if above.

IntegerRange range = IntegerRange.of(16, 64);
range.fit(-9) -->  16
range.fit(0)  -->  16
range.fit(15) -->  16
range.fit(16) -->  16
range.fit(17) -->  17
...
range.fit(63) -->  63
range.fit(64) -->  64
range.fit(99) -->  64

Parameters:

element - The element to test.

Returns:

The minimum, the element, or the maximum depending on the element's location relative to the range.

Since:

3.19.0

toIntStream

public IntStream toIntStream()

Returns a sequential ordered IntStream from Range.getMinimum() (inclusive) to Range.getMaximum() (inclusive) by an incremental step of 1.

Returns:

A sequential IntStream for the range of int elements.

Since:

3.18.0