Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.collect.Range

A range (or "interval") defines the boundaries around a contiguous span of values of some Comparable type; for example, "integers from 1 to 100 inclusive." Note that it is not possible to iterate over these contained values. To do so, pass this range instance and an appropriate DiscreteDomain to ContiguousSet#create.

Types of ranges

Each end of the range may be bounded or unbounded. If bounded, there is an associated endpoint value, and the range is considered to be either open (does not include the endpoint) or closed (includes the endpoint) on that side. With three possibilities on each side, this yields nine basic types of ranges, enumerated below. (Notation: a square bracket ([ ]) indicates that the range is closed on that side; a parenthesis (( )) means it is either open or unbounded. The construct {x | statement} is read "the set of all x such that statement.")

Range Types
Notation Definition Factory method
(a..b) {x | a < x < b} open
[a..b] {x | a <= x <= b} closed
(a..b] {x | a < x <= b} openClosed
[a..b) {x | a <= x < b} closedOpen
(a..+∞) {x | x > a} greaterThan
[a..+∞) {x | x >= a} atLeast
(-∞..b) {x | x < b} lessThan
(-∞..b] {x | x <= b} atMost
(-∞..+∞) {x} all

Range Types
Notation	Definition	Factory method
`(a..b)`	`{x \| a < x < b}`	`open`
`[a..b]`	`{x \| a <= x <= b}`	`closed`
`(a..b]`	`{x \| a < x <= b}`	`openClosed`
`[a..b)`	`{x \| a <= x < b}`	`closedOpen`
`(a..+∞)`	`{x \| x > a}`	`greaterThan`
`[a..+∞)`	`{x \| x >= a}`	`atLeast`
`(-∞..b)`	`{x \| x < b}`	`lessThan`
`(-∞..b]`	`{x \| x <= b}`	`atMost`
`(-∞..+∞)`	`{x}`	`all`

When both endpoints exist, the upper endpoint may not be less than the lower. The endpoints may be equal only if at least one of the bounds is closed:

[a..a] : a singleton range
[a..a); (a..a] : empty ranges; also valid
(a..a) : invalid; an exception will be thrown

Warnings

Use immutable value types only, if at all possible. If you must use a mutable type, do not allow the endpoint instances to mutate after the range is created!
Your value type's comparison method should be consistent with equals if at all possible. Otherwise, be aware that concepts used throughout this documentation such as "equal", "same", "unique" and so on actually refer to whether compareTo returns zero, not whether equals returns true.
A class which implements Comparable<UnrelatedType> is very broken, and will cause undefined horrible things to happen in Range. For now, the Range API does not prevent its use, because this would also rule out all ungenerified (pre-JDK1.5) data types. This may change in the future.

Other notes

All ranges are shallow-immutable.
Instances of this type are obtained using the static factory methods in this class.
Ranges are convex: whenever two values are contained, all values in between them must also be contained. More formally, for any c1 <= c2 <= c3 of type C, r.contains(c1) && r.contains(c3) implies r.contains(c2)). This means that a Range<Integer> can never be used to represent, say, "all prime numbers from 1 to 100."
When evaluated as a Predicate, a range yields the same result as invoking contains.
Terminology note: a range a is said to be the maximal range having property P if, for all ranges b also having property P, a.encloses(b). Likewise, a is minimal when b.encloses(a) for all b having property P. See, for example, the definition of intersection.
A Range is serializable if it has no bounds, or if each bound is serializable.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Range.RangeLexOrdering Needed to serialize sorted collections of Ranges.

Field Summary

Modifier and Type	Field and Description
private static final Range<Comparable<T>>	ALL
pack-priv final Cut<C>	lowerBound
private static final long	serialVersionUID
pack-priv final Cut<C>	upperBound

Constructor Summary

Access	Constructor and Description
private	Range(Cut<C> lowerBound, Cut<C> upperBound)

Method Summary

Modifier and Type	Method and Description
public static <C extends Comparable<?>> Range<C>	all() Returns a range that contains every value of type `C`.
public boolean	apply(C input) Implements com.google.common.base.Predicate.apply. Deprecated Provided only to satisfy the `Predicate` interface; use `contains` instead. Returns the result of applying this predicate to `input` (Java 8+ users, see notes in the class documentation above).
public static <C extends Comparable<?>> Range<C>	atLeast(C endpoint) Returns a range that contains all values greater than or equal to `endpoint`.
public static <C extends Comparable<?>> Range<C>	atMost(C endpoint) Returns a range that contains all values less than or equal to `endpoint`.
public Range<C>	canonical(DiscreteDomain<C> domain) Returns the canonical form of this range in the given domain.
public static <C extends Comparable<?>> Range<C>	closed(C lower, C upper) Returns a range that contains all values greater than or equal to `lower` and less than or equal to `upper`.
public static <C extends Comparable<?>> Range<C>	closedOpen(C lower, C upper) Returns a range that contains all values greater than or equal to `lower` and strictly less than `upper`.
pack-priv static int	compareOrThrow(Comparable<T> left, Comparable<T> right)
public boolean	contains(C value) Returns `true` if `value` is within the bounds of this range.
public boolean	containsAll(Iterable<? extends C> values) Returns `true` if every element in `values` is contained in this range.
pack-priv static <C extends Comparable<?>> Range<C>	create(Cut<C> lowerBound, Cut<C> upperBound)
public static <C extends Comparable<?>> Range<C>	downTo(C endpoint, BoundType boundType) Returns a range from the given endpoint, which may be either inclusive (closed) or exclusive (open), with no upper bound.
public static <C extends Comparable<?>> Range<C>	encloseAll(Iterable<C> values) Returns the minimal range that contains all of the given values.
public boolean	encloses(Range<C> other) Returns `true` if the bounds of `other` do not extend outside the bounds of this range.
public boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Implements com.google.common.base.Predicate.equals. Returns `true` if `object` is a range having the same endpoints and bound types as this range.
public Range<C>	gap(Range<C> otherRange) Returns the maximal range lying between this range and `otherRange`, if such a range exists.
public static <C extends Comparable<?>> Range<C>	greaterThan(C endpoint) Returns a range that contains all values strictly greater than `endpoint`.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this range.
public boolean	hasLowerBound() Returns `true` if this range has a lower endpoint.
public boolean	hasUpperBound() Returns `true` if this range has an upper endpoint.
public Range<C>	intersection(Range<C> connectedRange) Returns the maximal range enclosed by both this range and `connectedRange`, if such a range exists.
public boolean	isConnected(Range<C> other) Returns `true` if there exists a (possibly empty) range which is enclosed by both this range and `other`.
public boolean	isEmpty() Returns `true` if this range is of the form `[v..v)` or `(v..v]`.
public static <C extends Comparable<?>> Range<C>	lessThan(C endpoint) Returns a range that contains all values strictly less than `endpoint`.
pack-priv Cut<C>	lowerBound()
public BoundType	lowerBoundType() Returns the type of this range's lower bound: `BoundType#CLOSED` if the range includes its lower endpoint, `BoundType#OPEN` if it does not.
public C	lowerEndpoint() Returns the lower endpoint of this range.
public static <C extends Comparable<?>> Range<C>	open(C lower, C upper) Returns a range that contains all values strictly greater than `lower` and strictly less than `upper`.
public static <C extends Comparable<?>> Range<C>	openClosed(C lower, C upper) Returns a range that contains all values strictly greater than `lower` and less than or equal to `upper`.
public static <C extends Comparable<?>> Range<C>	range(C lower, BoundType lowerType, C upper, BoundType upperType) Returns a range that contains any value from `lower` to `upper`, where each endpoint may be either inclusive (closed) or exclusive (open).
pack-priv static <C extends Comparable<?>> Ordering<Range<C>>	rangeLexOrdering()
pack-priv Object	readResolve()
public static <C extends Comparable<?>> Range<C>	singleton(C value) Returns a range that contains only the given value.
public Range<C>	span(Range<C> other) Returns the minimal range that encloses both this range and `other`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of this range, such as `"[3..5)"` (other examples are listed in the class documentation).
private static String	toString(Cut<?> lowerBound, Cut<?> upperBound)
pack-priv Cut<C>	upperBound()
public BoundType	upperBoundType() Returns the type of this range's upper bound: `BoundType#CLOSED` if the range includes its upper endpoint, `BoundType#OPEN` if it does not.
public C	upperEndpoint() Returns the upper endpoint of this range.
public static <C extends Comparable<?>> Range<C>	upTo(C endpoint, BoundType boundType) Returns a range with no lower bound up to the given endpoint, which may be either inclusive (closed) or exclusive (open).

Field Detail

ALL	back to summary
private static final Range<Comparable<T>> ALL

lowerBound	back to summary
pack-priv final Cut<C> lowerBound

serialVersionUID	back to summary
private static final long serialVersionUID

upperBound	back to summary
pack-priv final Cut<C> upperBound

Constructor Detail

Range	back to summary
private Range(Cut<C> lowerBound, Cut<C> upperBound)

Method Detail

all back to summary

all	back to summary
public static <C extends Comparable<?>> Range<C> all() Returns a range that contains every value of type `C`. Annotations @SuppressWarnings:unchecked Since 14.0

public static <C extends Comparable<?>> Range<C> all()

Returns a range that contains every value of type C.

Annotations

@SuppressWarnings:unchecked

Since

14.0

apply back to summary

apply	back to summary
public boolean apply(C input) Implements com.google.common.base.Predicate.apply. Doc from com.google.common.base.Predicate.apply. Deprecated Provided only to satisfy the `Predicate` interface; use `contains` instead. Returns the result of applying this predicate to `input` (Java 8+ users, see notes in the class documentation above). This method is generally expected, but not absolutely required, to have the following properties: Its execution does not cause any observable side effects. The computation is consistent with equals; that is, `Objects.equal(a, b)` implies that `predicate.apply(a) == predicate.apply(b))`. Annotations @Deprecated @Override

public boolean apply(C input)

Implements com.google.common.base.Predicate.apply.

Doc from com.google.common.base.Predicate.apply.

Deprecated

Provided only to satisfy the Predicate interface; use contains instead.

Returns the result of applying this predicate to input (Java 8+ users, see notes in the class documentation above). This method is generally expected, but not absolutely required, to have the following properties:

Its execution does not cause any observable side effects.
The computation is consistent with equals; that is, Objects.equal(a, b) implies that predicate.apply(a) == predicate.apply(b)).

Annotations

@Deprecated
@Override

atLeast back to summary

atLeast	back to summary
public static <C extends Comparable<?>> Range<C> atLeast(C endpoint) Returns a range that contains all values greater than or equal to `endpoint`. Since 14.0

public static <C extends Comparable<?>> Range<C> atLeast(C endpoint)

Returns a range that contains all values greater than or equal to endpoint.

Since: 14.0

atMost back to summary

atMost	back to summary
public static <C extends Comparable<?>> Range<C> atMost(C endpoint) Returns a range that contains all values less than or equal to `endpoint`. Since 14.0

public static <C extends Comparable<?>> Range<C> atMost(C endpoint)

Returns a range that contains all values less than or equal to endpoint.

Since: 14.0

canonical back to summary

canonical	back to summary
public Range<C> canonical(DiscreteDomain<C> domain) Returns the canonical form of this range in the given domain. The canonical form has the following properties: equivalence: `a.canonical().contains(v) == a.contains(v)` for all `v` (in other words, `ContiguousSet.create(a.canonical(domain), domain).equals( ContiguousSet.create(a, domain))` uniqueness: unless `a.isEmpty()`, `ContiguousSet.create(a, domain).equals(ContiguousSet.create(b, domain))` implies `a.canonical(domain).equals(b.canonical(domain))` idempotence: `a.canonical(domain).canonical(domain).equals(a.canonical(domain))` Furthermore, this method guarantees that the range returned will be one of the following canonical forms: [start..end) [start..+∞) (-∞..end) (only if type `C` is unbounded below) (-∞..+∞) (only if type `C` is unbounded below)

public Range<C> canonical(DiscreteDomain<C> domain)

Returns the canonical form of this range in the given domain. The canonical form has the following properties:

equivalence: a.canonical().contains(v) == a.contains(v) for all v (in other words, ContiguousSet.create(a.canonical(domain), domain).equals( ContiguousSet.create(a, domain))
uniqueness: unless a.isEmpty(), ContiguousSet.create(a, domain).equals(ContiguousSet.create(b, domain)) implies a.canonical(domain).equals(b.canonical(domain))
idempotence: a.canonical(domain).canonical(domain).equals(a.canonical(domain))

Furthermore, this method guarantees that the range returned will be one of the following canonical forms:

[start..end)
[start..+∞)
(-∞..end) (only if type C is unbounded below)
(-∞..+∞) (only if type C is unbounded below)

closed back to summary

closed	back to summary
public static <C extends Comparable<?>> Range<C> closed(C lower, C upper) Returns a range that contains all values greater than or equal to `lower` and less than or equal to `upper`. Exceptions IllegalArgumentException: if `lower` is greater than `upper` ClassCastException: if `lower` and `upper` are not mutually comparable Since 14.0

public static <C extends Comparable<?>> Range<C> closed(C lower, C upper)

Returns a range that contains all values greater than or equal to lower and less than or equal to upper.

Exceptions

IllegalArgumentException:: if lower is greater than upper
ClassCastException:: if lower and upper are not mutually comparable

Since

14.0

closedOpen back to summary

closedOpen	back to summary
public static <C extends Comparable<?>> Range<C> closedOpen(C lower, C upper) Returns a range that contains all values greater than or equal to `lower` and strictly less than `upper`. Exceptions IllegalArgumentException: if `lower` is greater than `upper` ClassCastException: if `lower` and `upper` are not mutually comparable Since 14.0

public static <C extends Comparable<?>> Range<C> closedOpen(C lower, C upper)

Returns a range that contains all values greater than or equal to lower and strictly less than upper.

Exceptions

IllegalArgumentException:: if lower is greater than upper
ClassCastException:: if lower and upper are not mutually comparable

Since

14.0

compareOrThrow	back to summary
pack-priv static int compareOrThrow(Comparable<T> left, Comparable<T> right) Annotations @SuppressWarnings:unchecked

contains	back to summary
public boolean contains(C value) Returns `true` if `value` is within the bounds of this range. For example, on the range `[0..2)`, `contains(1)` returns `true`, while `contains(2)` returns `false`.

containsAll	back to summary
public boolean containsAll(Iterable<? extends C> values) Returns `true` if every element in `values` is contained in this range.

create	back to summary
pack-priv static <C extends Comparable<?>> Range<C> create(Cut<C> lowerBound, Cut<C> upperBound)

downTo	back to summary
public static <C extends Comparable<?>> Range<C> downTo(C endpoint, BoundType boundType) Returns a range from the given endpoint, which may be either inclusive (closed) or exclusive (open), with no upper bound. Since 14.0

downTo

back to summary

public static <C extends Comparable<?>> Range<C> downTo(C endpoint, BoundType boundType)

Returns a range from the given endpoint, which may be either inclusive (closed) or exclusive (open), with no upper bound.

Since: 14.0

encloseAll back to summary

encloseAll	back to summary
public static <C extends Comparable<?>> Range<C> encloseAll(Iterable<C> values) Returns the minimal range that contains all of the given values. The returned range is closed on both ends. Exceptions ClassCastException: if the values are not mutually comparable NoSuchElementException: if `values` is empty NullPointerException: if any of `values` is null Since 14.0

public static <C extends Comparable<?>> Range<C> encloseAll(Iterable<C> values)

Returns the minimal range that contains all of the given values. The returned range is closed on both ends.

Exceptions

ClassCastException:: if the values are not mutually comparable
NoSuchElementException:: if values is empty
NullPointerException:: if any of values is null

Since

14.0

encloses back to summary

encloses	back to summary
public boolean encloses(Range<C> other) Returns `true` if the bounds of `other` do not extend outside the bounds of this range. Examples: `[3..6]` encloses `[4..5]` `(3..6)` encloses `(3..6)` `[3..6]` encloses `[4..4)` (even though the latter is empty) `(3..6]` does not enclose `[3..6]` `[4..5]` does not enclose `(3..6)` (even though it contains every value contained by the latter range) `[3..6]` does not enclose `(1..1]` (even though it contains every value contained by the latter range) Note that if `a.encloses(b)`, then `b.contains(v)` implies `a.contains(v)`, but as the last two examples illustrate, the converse is not always true. Being reflexive, antisymmetric and transitive, the `encloses` relation defines a partial order over ranges. There exists a unique maximal range according to this relation, and also numerous minimal ranges. Enclosure also implies connectedness.

public boolean encloses(Range<C> other)

Returns true if the bounds of other do not extend outside the bounds of this range. Examples:

[3..6] encloses [4..5]
(3..6) encloses (3..6)
[3..6] encloses [4..4) (even though the latter is empty)
(3..6] does not enclose [3..6]
[4..5] does not enclose (3..6) (even though it contains every value contained by the latter range)
[3..6] does not enclose (1..1] (even though it contains every value contained by the latter range)

Note that if a.encloses(b), then b.contains(v) implies a.contains(v), but as the last two examples illustrate, the converse is not always true.

Being reflexive, antisymmetric and transitive, the encloses relation defines a partial order over ranges. There exists a unique maximal range according to this relation, and also numerous minimal ranges. Enclosure also implies connectedness.

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Implements com.google.common.base.Predicate.equals. Returns `true` if `object` is a range having the same endpoints and bound types as this range. Note that discrete ranges such as `(1..4)` and `[2..3]` are not equal to one another, despite the fact that they each contain precisely the same set of values. Similarly, empty ranges are not equal unless they have exactly the same representation, so `[3..3)`, `(3..3]`, `(4..4]` are all unequal. Parameters object:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Implements com.google.common.base.Predicate.equals.

Returns true if object is a range having the same endpoints and bound types as this range. Note that discrete ranges such as (1..4) and [2..3] are not equal to one another, despite the fact that they each contain precisely the same set of values. Similarly, empty ranges are not equal unless they have exactly the same representation, so [3..3), (3..3], (4..4] are all unequal.

Parameters

object:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

gap back to summary

gap	back to summary
public Range<C> gap(Range<C> otherRange) Returns the maximal range lying between this range and `otherRange`, if such a range exists. The resulting range may be empty if the two ranges are adjacent but non-overlapping. For example, the gap of `[1..5]` and `(7..10)` is `(5..7]`. The resulting range may be empty; for example, the gap between `[1..5)` `[5..7)` yields the empty range `[5..5)`. The gap exists if and only if the two ranges are either disconnected or immediately adjacent (any intersection must be an empty range). The gap operation is commutative. Exceptions IllegalArgumentException: if this range and `otherRange` have a nonempty intersection Since 27.0

public Range<C> gap(Range<C> otherRange)

Returns the maximal range lying between this range and otherRange, if such a range exists. The resulting range may be empty if the two ranges are adjacent but non-overlapping.

For example, the gap of [1..5] and (7..10) is (5..7]. The resulting range may be empty; for example, the gap between [1..5) [5..7) yields the empty range [5..5).

The gap exists if and only if the two ranges are either disconnected or immediately adjacent (any intersection must be an empty range).

The gap operation is commutative.

Exceptions

IllegalArgumentException:: if this range and otherRange have a nonempty intersection

Since

27.0

greaterThan back to summary

greaterThan	back to summary
public static <C extends Comparable<?>> Range<C> greaterThan(C endpoint) Returns a range that contains all values strictly greater than `endpoint`. Since 14.0

public static <C extends Comparable<?>> Range<C> greaterThan(C endpoint)

Returns a range that contains all values strictly greater than endpoint.

Since: 14.0

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this range. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code for this range.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

hasLowerBound	back to summary
public boolean hasLowerBound() Returns `true` if this range has a lower endpoint.

hasUpperBound	back to summary
public boolean hasUpperBound() Returns `true` if this range has an upper endpoint.

intersection back to summary

intersection	back to summary
public Range<C> intersection(Range<C> connectedRange) Returns the maximal range enclosed by both this range and `connectedRange`, if such a range exists. For example, the intersection of `[1..5]` and `(3..7)` is `(3..5]`. The resulting range may be empty; for example, `[1..5)` intersected with `[5..7)` yields the empty range `[5..5)`. The intersection exists if and only if the two ranges are connected. The intersection operation is commutative, associative and idempotent, and its identity element is `Range#all`). Exceptions IllegalArgumentException: if `isConnected(connectedRange)` is `false`

public Range<C> intersection(Range<C> connectedRange)

Returns the maximal range enclosed by both this range and connectedRange, if such a range exists.

For example, the intersection of [1..5] and (3..7) is (3..5]. The resulting range may be empty; for example, [1..5) intersected with [5..7) yields the empty range [5..5).

The intersection exists if and only if the two ranges are connected.

The intersection operation is commutative, associative and idempotent, and its identity element is Range#all).

Exceptions

IllegalArgumentException:: if isConnected(connectedRange) is false

isConnected back to summary

isConnected	back to summary
public boolean isConnected(Range<C> other) Returns `true` if there exists a (possibly empty) range which is enclosed by both this range and `other`. For example, `[2, 4)` and `[5, 7)` are not connected `[2, 4)` and `[3, 5)` are connected, because both enclose `[3, 4)` `[2, 4)` and `[4, 6)` are connected, because both enclose the empty range `[4, 4)` Note that this range and `other` have a well-defined union and intersection (as a single, possibly-empty range) if and only if this method returns `true`. The connectedness relation is both reflexive and symmetric, but does not form an equivalence relation as it is not transitive. Note that certain discrete ranges are not considered connected, even though there are no elements "between them." For example, `[3, 5]` is not considered connected to `[6, 10]`. In these cases, it may be desirable for both input ranges to be preprocessed with `canonical(DiscreteDomain)` before testing for connectedness.

public boolean isConnected(Range<C> other)

Returns true if there exists a (possibly empty) range which is enclosed by both this range and other.

For example,

[2, 4) and [5, 7) are not connected
[2, 4) and [3, 5) are connected, because both enclose [3, 4)
[2, 4) and [4, 6) are connected, because both enclose the empty range [4, 4)

Note that this range and other have a well-defined union and intersection (as a single, possibly-empty range) if and only if this method returns true.

The connectedness relation is both reflexive and symmetric, but does not form an equivalence relation as it is not transitive.

Note that certain discrete ranges are not considered connected, even though there are no elements "between them." For example, [3, 5] is not considered connected to [6, 10]. In these cases, it may be desirable for both input ranges to be preprocessed with canonical(DiscreteDomain) before testing for connectedness.

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Returns `true` if this range is of the form `[v..v)` or `(v..v]`. (This does not encompass ranges of the form `(v..v)`, because such ranges are invalid and can't be constructed at all.) Note that certain discrete ranges such as the integer range `(3..4)` are not considered empty, even though they contain no actual values. In these cases, it may be helpful to preprocess ranges with `canonical(DiscreteDomain)`.

public boolean isEmpty()

Returns true if this range is of the form [v..v) or (v..v]. (This does not encompass ranges of the form (v..v), because such ranges are invalid and can't be constructed at all.)

Note that certain discrete ranges such as the integer range (3..4) are not considered empty, even though they contain no actual values. In these cases, it may be helpful to preprocess ranges with canonical(DiscreteDomain).

lessThan back to summary

lessThan	back to summary
public static <C extends Comparable<?>> Range<C> lessThan(C endpoint) Returns a range that contains all values strictly less than `endpoint`. Since 14.0

public static <C extends Comparable<?>> Range<C> lessThan(C endpoint)

Returns a range that contains all values strictly less than endpoint.

Since: 14.0

lowerBound	back to summary
pack-priv Cut<C> lowerBound()

lowerBoundType back to summary

lowerBoundType	back to summary
public BoundType lowerBoundType() Returns the type of this range's lower bound: `BoundType#CLOSED` if the range includes its lower endpoint, `BoundType#OPEN` if it does not. Exceptions IllegalStateException: if this range is unbounded below (that is, `hasLowerBound()` returns `false`)

public BoundType lowerBoundType()

Returns the type of this range's lower bound: BoundType#CLOSED if the range includes its lower endpoint, BoundType#OPEN if it does not.

Exceptions

IllegalStateException:: if this range is unbounded below (that is, hasLowerBound() returns false)

lowerEndpoint back to summary

lowerEndpoint	back to summary
public C lowerEndpoint() Returns the lower endpoint of this range. Exceptions IllegalStateException: if this range is unbounded below (that is, `hasLowerBound()` returns `false`)

public C lowerEndpoint()

Returns the lower endpoint of this range.

Exceptions

IllegalStateException:: if this range is unbounded below (that is, hasLowerBound() returns false)

open back to summary

open	back to summary
public static <C extends Comparable<?>> Range<C> open(C lower, C upper) Returns a range that contains all values strictly greater than `lower` and strictly less than `upper`. Exceptions IllegalArgumentException: if `lower` is greater than or equal to `upper` ClassCastException: if `lower` and `upper` are not mutually comparable Since 14.0

public static <C extends Comparable<?>> Range<C> open(C lower, C upper)

Returns a range that contains all values strictly greater than lower and strictly less than upper.

Exceptions

IllegalArgumentException:: if lower is greater than or equal to upper
ClassCastException:: if lower and upper are not mutually comparable

Since

14.0

openClosed back to summary

openClosed	back to summary
public static <C extends Comparable<?>> Range<C> openClosed(C lower, C upper) Returns a range that contains all values strictly greater than `lower` and less than or equal to `upper`. Exceptions IllegalArgumentException: if `lower` is greater than `upper` ClassCastException: if `lower` and `upper` are not mutually comparable Since 14.0

public static <C extends Comparable<?>> Range<C> openClosed(C lower, C upper)

Returns a range that contains all values strictly greater than lower and less than or equal to upper.

Exceptions

IllegalArgumentException:: if lower is greater than upper
ClassCastException:: if lower and upper are not mutually comparable

Since

14.0

range back to summary

range	back to summary
public static <C extends Comparable<?>> Range<C> range(C lower, BoundType lowerType, C upper, BoundType upperType) Returns a range that contains any value from `lower` to `upper`, where each endpoint may be either inclusive (closed) or exclusive (open). Exceptions IllegalArgumentException: if `lower` is greater than `upper` ClassCastException: if `lower` and `upper` are not mutually comparable Since 14.0

public static <C extends Comparable<?>> Range<C> range(C lower, BoundType lowerType, C upper, BoundType upperType)

Returns a range that contains any value from lower to upper, where each endpoint may be either inclusive (closed) or exclusive (open).

Exceptions

IllegalArgumentException:: if lower is greater than upper
ClassCastException:: if lower and upper are not mutually comparable

Since

14.0

rangeLexOrdering	back to summary
pack-priv static <C extends Comparable<?>> Ordering<Range<C>> rangeLexOrdering() Annotations @SuppressWarnings:unchecked

readResolve	back to summary
pack-priv Object readResolve()

singleton	back to summary
public static <C extends Comparable<?>> Range<C> singleton(C value) Returns a range that contains only the given value. The returned range is closed on both ends. Since 14.0

singleton

back to summary

public static <C extends Comparable<?>> Range<C> singleton(C value)

Returns a range that contains only the given value. The returned range is closed on both ends.

Since: 14.0

span back to summary

span	back to summary
public Range<C> span(Range<C> other) Returns the minimal range that encloses both this range and `other`. For example, the span of `[1..3]` and `(5..7)` is `[1..7)`. If the input ranges are connected, the returned range can also be called their union. If they are not, note that the span might contain values that are not contained in either input range. Like `intersection`, this operation is commutative, associative and idempotent. Unlike it, it is always well-defined for any two input ranges.

public Range<C> span(Range<C> other)

Returns the minimal range that encloses both this range and other. For example, the span of [1..3] and (5..7) is [1..7).

If the input ranges are connected, the returned range can also be called their union. If they are not, note that the span might contain values that are not contained in either input range.

Like intersection, this operation is commutative, associative and idempotent. Unlike it, it is always well-defined for any two input ranges.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of this range, such as `"[3..5)"` (other examples are listed in the class documentation). Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this range, such as "[3..5)" (other examples are listed in the class documentation).

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

toString	back to summary
private static String toString(Cut<?> lowerBound, Cut<?> upperBound)

upperBound	back to summary
pack-priv Cut<C> upperBound()

upperBoundType back to summary

upperBoundType	back to summary
public BoundType upperBoundType() Returns the type of this range's upper bound: `BoundType#CLOSED` if the range includes its upper endpoint, `BoundType#OPEN` if it does not. Exceptions IllegalStateException: if this range is unbounded above (that is, `hasUpperBound()` returns `false`)

public BoundType upperBoundType()

Returns the type of this range's upper bound: BoundType#CLOSED if the range includes its upper endpoint, BoundType#OPEN if it does not.

Exceptions

IllegalStateException:: if this range is unbounded above (that is, hasUpperBound() returns false)

upperEndpoint back to summary

upperEndpoint	back to summary
public C upperEndpoint() Returns the upper endpoint of this range. Exceptions IllegalStateException: if this range is unbounded above (that is, `hasUpperBound()` returns `false`)

public C upperEndpoint()

Returns the upper endpoint of this range.

Exceptions

IllegalStateException:: if this range is unbounded above (that is, hasUpperBound() returns false)

upTo	back to summary
public static <C extends Comparable<?>> Range<C> upTo(C endpoint, BoundType boundType) Returns a range with no lower bound up to the given endpoint, which may be either inclusive (closed) or exclusive (open). Since 14.0

upTo

back to summary

public static <C extends Comparable<?>> Range<C> upTo(C endpoint, BoundType boundType)

Returns a range with no lower bound up to the given endpoint, which may be either inclusive (closed) or exclusive (open).

Since: 14.0

public final Class Range<C extends Comparable<T>>

Types of ranges

Warnings

Other notes

Further reading

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Range.RangeLexOrdering

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
pack-priv static final Ordering<?>	INSTANCE
private static final long	serialVersionUID