org.apache.commons.lang3

Class LongRange

java.lang.Object

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

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

org.apache.commons.lang3.LongRange

All Implemented Interfaces:

Serializable

public final class LongRange
extends NumberRange<Long>

Specializes NumberRange for Longs.

This class is not designed to interoperate with other NumberRanges

Since:

3.13.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static LongRange	of(long fromInclusive, long toInclusive) Creates a closed range with the specified minimum and maximum values (both inclusive).
static LongRange	of(Long fromInclusive, Long toInclusive) Creates a closed range with the specified minimum and maximum values (both inclusive).
LongStream	toLongStream() Returns a sequential ordered LongStream from Range.getMinimum() (inclusive) to Range.getMaximum() (inclusive) by an incremental step of 1.

Methods inherited from class org.apache.commons.lang3.Range

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

Methods inherited from class java.lang.Object

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

Method Detail

of

public static LongRange of(long fromInclusive,
                           long 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 LongRange of(Long fromInclusive,
                           Long 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:

IllegalArgumentException - if either element is null.

toLongStream

public LongStream toLongStream()

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

Returns:

a sequential LongStream for the range of long elements

Since:

3.18.0