NavigableSet
interface NavigableSet<E : Any!> : SortedSet<E>
| java.util.NavigableSet |
A SortedSet extended with navigation methods reporting closest matches for given search targets. Methods lower, floor, ceiling, and higher return elements respectively less than, less than or equal, greater than or equal, and greater than a given element, returning null if there is no such element.
A NavigableSet may be accessed and traversed in either ascending or descending order. The descendingSet method returns a view of the set with the senses of all relational and directional methods inverted. The performance of ascending operations and views is likely to be faster than that of descending ones. This interface additionally defines methods pollFirst and pollLast that return and remove the lowest and highest element, if one exists, else returning null. Methods subSet(E, boolean, E, boolean), headSet(E, boolean), and tailSet(E, boolean) differ from the like-named SortedSet methods in accepting additional arguments describing whether lower and upper bounds are inclusive versus exclusive. Subsets of any NavigableSet must implement the NavigableSet interface.
The return values of navigation methods may be ambiguous in implementations that permit null elements. However, even in this case the result can be disambiguated by checking contains(null). To avoid such issues, implementations of this interface are encouraged to not permit insertion of null elements. (Note that sorted sets of Comparable elements intrinsically do not permit null.)
Methods subSet(E, E), headSet(E), and tailSet(E) are specified to return SortedSet to allow existing implementations of SortedSet to be compatibly retrofitted to implement NavigableSet, but extensions and implementations of this interface are encouraged to override these methods to return NavigableSet.
Summary
| Public methods | |
|---|---|
| abstract E |
ceiling(: E)Returns the least element in this set greater than or equal to the given element, or |
| abstract MutableIterator<E>! |
Returns an iterator over the elements in this set, in descending order. |
| abstract NavigableSet<E>! |
Returns a reverse order view of the elements contained in this set. |
| abstract E |
floor(: E)Returns the greatest element in this set less than or equal to the given element, or |
| abstract NavigableSet<E>! |
Returns a view of the portion of this set whose elements are less than (or equal to, if |
| abstract SortedSet<E>! |
headSet(: E)Returns a view of the portion of this set whose elements are strictly less than |
| abstract E |
higher(: E)Returns the least element in this set strictly greater than the given element, or |
| abstract MutableIterator<E> |
iterator()Returns an iterator over the elements in this set, in ascending order. |
| abstract E |
lower(: E)Returns the greatest element in this set strictly less than the given element, or |
| abstract E |
Retrieves and removes the first (lowest) element, or returns |
| abstract E |
pollLast()Retrieves and removes the last (highest) element, or returns |
| open E |
Removes and returns the first element of this collection (optional operation). |
| open E |
Removes and returns the last element of this collection (optional operation). |
| open NavigableSet<E>! |
reversed()Returns a reverse-ordered view of this collection. |
| abstract NavigableSet<E>! |
Returns a view of the portion of this set whose elements range from |
| abstract SortedSet<E>! |
subSet(: E, : E)Returns a view of the portion of this set whose elements range from |
| abstract NavigableSet<E>! |
Returns a view of the portion of this set whose elements are greater than (or equal to, if |
| abstract SortedSet<E>! |
tailSet(: E)Returns a view of the portion of this set whose elements are greater than or equal to |
| Inherited functions | |
|---|---|
Public methods
ceiling
abstract fun ceiling(: E): E
Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
| Parameters | |
|---|---|
e |
E: the value to match |
| Return | |
|---|---|
E |
the least element greater than or equal to e, or null if there is no such element |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
if the specified element cannot be compared with the elements currently in the set |
java.lang.NullPointerException |
if the specified element is null and this set does not permit null elements |
descendingIterator
abstract fun descendingIterator(): MutableIterator<E>!
Returns an iterator over the elements in this set, in descending order. Equivalent in effect to descendingSet().iterator().
| Return | |
|---|---|
MutableIterator<E>! |
an iterator over the elements in this set, in descending order |
descendingSet
abstract fun descendingSet(): NavigableSet<E>!
Returns a reverse order view of the elements contained in this set. The descending set is backed by this set, so changes to the set are reflected in the descending set, and vice-versa. If either set is modified while an iteration over either set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.
The returned set has an ordering equivalent to Collections.reverseOrder(comparator()). The expression s.descendingSet().descendingSet() returns a view of s essentially equivalent to s.
| Return | |
|---|---|
NavigableSet<E>! |
a reverse order view of this set |
floor
abstract fun floor(: E): E
Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
| Parameters | |
|---|---|
e |
E: the value to match |
| Return | |
|---|---|
E |
the greatest element less than or equal to e, or null if there is no such element |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
if the specified element cannot be compared with the elements currently in the set |
java.lang.NullPointerException |
if the specified element is null and this set does not permit null elements |
headSet
abstract fun headSet(
: E,
: Boolean
): NavigableSet<E>!
Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) 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 |
E: high endpoint of the returned set |
inclusive |
Boolean: true if the high endpoint is to be included in the returned view |
| Return | |
|---|---|
NavigableSet<E>! |
a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
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. |
java.lang.NullPointerException |
if toElement is null and this set does not permit null elements |
java.lang.IllegalArgumentException |
if this set itself has a restricted range, and toElement lies outside the bounds of the range |
headSet
abstract fun headSet(: E): SortedSet<E>!
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.
Equivalent to headSet(toElement, false).
| Parameters | |
|---|---|
toElement |
E: high endpoint (exclusive) of the returned set |
| Return | |
|---|---|
SortedSet<E>! |
a view of the portion of this set whose elements are strictly less than toElement |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
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. |
java.lang.NullPointerException |
if toElement is null and this set does not permit null elements |
java.lang.IllegalArgumentException |
if this set itself has a restricted range, and toElement lies outside the bounds of the range |
higher
abstract fun higher(: E): E
Returns the least element in this set strictly greater than the given element, or null if there is no such element.
| Parameters | |
|---|---|
e |
E: the value to match |
| Return | |
|---|---|
E |
the least element greater than e, or null if there is no such element |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
if the specified element cannot be compared with the elements currently in the set |
java.lang.NullPointerException |
if the specified element is null and this set does not permit null elements |
iterator
abstract fun iterator(): MutableIterator<E>
Returns an iterator over the elements in this set, in ascending order.
| Return | |
|---|---|
MutableIterator<E> |
an iterator over the elements in this set, in ascending order |
lower
abstract fun lower(: E): E
Returns the greatest element in this set strictly less than the given element, or null if there is no such element.
| Parameters | |
|---|---|
e |
E: the value to match |
| Return | |
|---|---|
E |
the greatest element less than e, or null if there is no such element |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
if the specified element cannot be compared with the elements currently in the set |
java.lang.NullPointerException |
if the specified element is null and this set does not permit null elements |
pollFirst
abstract fun pollFirst(): E
Retrieves and removes the first (lowest) element, or returns null if this set is empty.
| Return | |
|---|---|
E |
the first element, or null if this set is empty |
pollLast
abstract fun pollLast(): E
Retrieves and removes the last (highest) element, or returns null if this set is empty.
| Return | |
|---|---|
E |
the last element, or null if this set is empty |
removeFirst
open fun removeFirst(): E
Removes and returns the first element of this collection (optional operation).
| Return | |
|---|---|
E |
the removed element |
| Exceptions | |
|---|---|
java.util.NoSuchElementException |
if this collection is empty |
java.lang.UnsupportedOperationException |
if this collection implementation does not support this operation |
removeLast
open fun removeLast(): E
Removes and returns the last element of this collection (optional operation).
| Return | |
|---|---|
E |
the removed element |
| Exceptions | |
|---|---|
java.util.NoSuchElementException |
if this collection is empty |
java.lang.UnsupportedOperationException |
if this collection implementation does not support this operation |
reversed
open fun reversed(): NavigableSet<E>!
Returns a reverse-ordered view of this collection. The encounter order of elements in the returned view is the inverse of the encounter order of elements in this collection. The reverse ordering affects all order-sensitive operations, including those on the view collections of the returned view. If the collection implementation permits modifications to this view, the modifications "write through" to the underlying collection. Changes to the underlying collection might or might not be visible in this reversed view, depending upon the implementation.
This method is equivalent to descendingSet.
| Return | |
|---|---|
NavigableSet<E>! |
a reverse-ordered view of this collection, as a NavigableSet |
subSet
abstract fun subSet(
: E,
: Boolean,
: E,
: Boolean
): NavigableSet<E>!
Returns a view of the portion of this set whose elements range from fromElement to toElement. If fromElement and toElement are equal, the returned set is empty unless fromInclusive and toInclusive are both true. 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 |
E: low endpoint of the returned set |
fromInclusive |
Boolean: true if the low endpoint is to be included in the returned view |
toElement |
E: high endpoint of the returned set |
toInclusive |
Boolean: true if the high endpoint is to be included in the returned view |
| Return | |
|---|---|
NavigableSet<E>! |
a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
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. |
java.lang.NullPointerException |
if fromElement or toElement is null and this set does not permit null elements |
java.lang.IllegalArgumentException |
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. |
subSet
abstract fun subSet(
: E,
: E
): SortedSet<E>!
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.
Equivalent to subSet(fromElement, true, toElement, false).
| Parameters | |
|---|---|
fromElement |
E: low endpoint (inclusive) of the returned set |
toElement |
E: high endpoint (exclusive) of the returned set |
| Return | |
|---|---|
SortedSet<E>! |
a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
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. |
java.lang.NullPointerException |
if fromElement or toElement is null and this set does not permit null elements |
java.lang.IllegalArgumentException |
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 |
tailSet
abstract fun tailSet(
: E,
: Boolean
): NavigableSet<E>!
Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) 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 |
E: low endpoint of the returned set |
inclusive |
Boolean: true if the low endpoint is to be included in the returned view |
| Return | |
|---|---|
NavigableSet<E>! |
a view of the portion of this set whose elements are greater than or equal to fromElement |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
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. |
java.lang.NullPointerException |
if fromElement is null and this set does not permit null elements |
java.lang.IllegalArgumentException |
if this set itself has a restricted range, and fromElement lies outside the bounds of the range |
tailSet
abstract fun tailSet(: E): SortedSet<E>!
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.
Equivalent to tailSet(fromElement, true).
| Parameters | |
|---|---|
fromElement |
E: low endpoint (inclusive) of the returned set |
| Return | |
|---|---|
SortedSet<E>! |
a view of the portion of this set whose elements are greater than or equal to fromElement |
| Exceptions | |
|---|---|
java.lang.ClassCastException |
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. |
java.lang.NullPointerException |
if fromElement is null and this set does not permit null elements |
java.lang.IllegalArgumentException |
if this set itself has a restricted range, and fromElement lies outside the bounds of the range |