org.platestack.structure.immutable

Interface ImmutableSortedSet<E>

Type Parameters:

E - the type of elements contained in the list. The list is covariant on its element type.

All Superinterfaces:

ImmutableCollection<E>, ImmutableSet<E>

All Known Subinterfaces:

ImmutableNavigableSet<E>

public ImmutableSortedSet<E>
extends ImmutableSet<E>

An interface that mimics the original SortedSet but without exposing modification functions to Kotlin source codes.

Modifications are strictly forbidden after the map is created.

See Also:

SortedSet

Method Summary

Modifier and Type	Method and Description
java.util.Comparator<? super E>	comparator() Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.
E	first() Returns the first (lowest) element currently in this set.
ImmutableSortedSet<E>	head(E toElement) Returns a view of the portion of this set whose elements are strictly less than toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.
E	last() Returns the last (highest) element currently in this set.
ImmutableSortedSet<E>	sub(E fromElement, E toElement) Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive. (If fromElement and toElement are equal, the returned set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.
ImmutableSortedSet<E>	tail(E fromElement) Returns a view of the portion of this set whose elements are greater than or equal to fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

Method Detail

comparator

java.util.Comparator<? super E> comparator()

Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.

Returns:

the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements

sub

ImmutableSortedSet<E> sub(E fromElement,
                          E toElement)

Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive. (If fromElement and toElement are equal, the returned set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters:

fromElement - low endpoint (inclusive) of the returned set

toElement - high endpoint (exclusive) of the returned set

Returns:

a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive

Throws:

- if fromElement and toElement cannot be compared to one another using this set's comparator (or, if the set has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromElement or toElement cannot be compared to elements currently in the set.

- if fromElement or toElement is null and this set does not permit null elements

- if fromElement is greater than toElement; or if this set itself has a restricted range, and fromElement or toElement lies outside the bounds of the range

head

ImmutableSortedSet<E> head(E toElement)

Returns a view of the portion of this set whose elements are strictly less than toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters:

toElement - high endpoint (exclusive) of the returned set

Returns:

a view of the portion of this set whose elements are strictly less than toElement

Throws:

- if toElement is not compatible with this set's comparator (or, if the set has no comparator, if toElement does not implement Comparable). Implementations may, but are not required to, throw this exception if toElement cannot be compared to elements currently in the set.

- if toElement is null and this set does not permit null elements

- if this set itself has a restricted range, and toElement lies outside the bounds of the range

tail

ImmutableSortedSet<E> tail(E fromElement)

Returns a view of the portion of this set whose elements are greater than or equal to fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters:

fromElement - low endpoint (inclusive) of the returned set

Returns:

a view of the portion of this set whose elements are greater than or equal to fromElement

Throws:

- if fromElement is not compatible with this set's comparator (or, if the set has no comparator, if fromElement does not implement Comparable). Implementations may, but are not required to, throw this exception if fromElement cannot be compared to elements currently in the set.

- if fromElement is null and this set does not permit null elements

- if this set itself has a restricted range, and fromElement lies outside the bounds of the range

first

E first()

Returns the first (lowest) element currently in this set.

Returns:

the first (lowest) element currently in this set

Throws:

- if this set is empty

last

E last()

Returns the last (highest) element currently in this set.

Returns:

the last (highest) element currently in this set

Throws:

- if this set is empty