E
- the type of elements maintained by this setCollection<E>
, Iterable<E>
, SequencedCollection<E>
, SequencedSet<E>
, Set<E>
NavigableSet<E>
ConcurrentSkipListSet
, TreeSet
public interface SortedSet<E> extends Set<E>, SequencedSet<E>
Set
that further provides a total ordering on its elements. The elements are ordered using their natural ordering, or by a Comparator
typically provided at sorted set creation time. The set's iterator will traverse the set in ascending element order. Several additional operations are provided to take advantage of the ordering. (This interface is the set analogue of SortedMap
.) All elements inserted into a sorted set must implement the Comparable
interface (or be accepted by the specified comparator). Furthermore, all such elements must be mutually comparable: e1.compareTo(e2)
(or comparator.compare(e1, e2)
) must not throw a ClassCastException
for any elements e1
and e2
in the sorted set. Attempts to violate this restriction will cause the offending method or constructor invocation to throw a ClassCastException
.
Note that the ordering maintained by a sorted set (whether or not an explicit comparator is provided) must be consistent with equals if the sorted set is to correctly implement the Set
interface. (See the Comparable
interface or Comparator
interface for a precise definition of consistent with equals.) This is so because the Set
interface is defined in terms of the equals
operation, but a sorted set performs all element comparisons using its compareTo
(or compare
) method, so two elements that are deemed equal by this method are, from the standpoint of the sorted set, equal. The behavior of a sorted set is well-defined even if its ordering is inconsistent with equals; it just fails to obey the general contract of the Set
interface.
All general-purpose sorted set implementation classes should provide four "standard" constructors: 1) A void (no arguments) constructor, which creates an empty sorted set sorted according to the natural ordering of its elements. 2) A constructor with a single argument of type Comparator
, which creates an empty sorted set sorted according to the specified comparator. 3) A constructor with a single argument of type Collection
, which creates a new sorted set with the same elements as its argument, sorted according to the natural ordering of the elements. 4) A constructor with a single argument of type SortedSet
, which creates a new sorted set with the same elements and the same ordering as the input sorted set. There is no way to enforce this recommendation, as interfaces cannot contain constructors.
Note: several methods return subsets with restricted ranges. Such ranges are half-open, that is, they include their low endpoint but not their high endpoint (where applicable). If you need a closed range (which includes both endpoints), and the element type allows for calculation of the successor of a given value, merely request the subrange from lowEndpoint
to successor(highEndpoint)
. For example, suppose that s
is a sorted set of strings. The following idiom obtains a view containing all of the strings in s
from low
to high
, inclusive:
SortedSet<String> sub = s.subSet(low, high+"\0");A similar technique can be used to generate an open range (which contains neither endpoint). The following idiom obtains a view containing all of the Strings in
s
from low
to high
, exclusive:SortedSet<String> sub = s.subSet(low+"\0", high);
This interface is a member of the Java Collections Framework.
Modifier and Type | Method | Description |
---|---|---|
default void |
addFirst |
Throws UnsupportedOperationException . |
default void |
addLast |
Throws UnsupportedOperationException . |
Comparator |
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. |
default E |
getFirst() |
Gets the first element of this collection. |
default E |
getLast() |
Gets the last element of this collection. |
SortedSet |
headSet |
Returns a view of the portion of this set whose elements are strictly less than toElement . |
E |
last() |
Returns the last (highest) element currently in this set. |
default E |
removeFirst() |
Removes and returns the first element of this collection (optional operation). |
default E |
removeLast() |
Removes and returns the last element of this collection (optional operation). |
default SortedSet |
reversed() |
Returns a reverse-ordered view of this collection. |
default Spliterator |
spliterator() |
Creates a Spliterator over the elements in this sorted set. |
SortedSet |
subSet |
Returns a view of the portion of this set whose elements range from fromElement , inclusive, to toElement , exclusive. |
SortedSet |
tailSet |
Returns a view of the portion of this set whose elements are greater than or equal to fromElement . |
parallelStream, removeIf, stream, toArray
Comparator<? super E> comparator()
null
if this set uses the natural ordering of its elements.null
if this set uses the natural ordering of its elementsSortedSet<E> subSet(E fromElement, E toElement)
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.
fromElement
- low endpoint (inclusive) of the returned settoElement
- high endpoint (exclusive) of the returned setfromElement
, inclusive, to toElement
, exclusiveClassCastException
- 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.NullPointerException
- if fromElement
or toElement
is null and this set does not permit null elementsIllegalArgumentException
- 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 rangeSortedSet<E> headSet(E toElement)
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.
toElement
- high endpoint (exclusive) of the returned settoElement
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.NullPointerException
- if toElement
is null and this set does not permit null elementsIllegalArgumentException
- if this set itself has a restricted range, and toElement
lies outside the bounds of the rangeSortedSet<E> tailSet(E fromElement)
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.
fromElement
- low endpoint (inclusive) of the returned setfromElement
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.NullPointerException
- if fromElement
is null and this set does not permit null elementsIllegalArgumentException
- if this set itself has a restricted range, and fromElement
lies outside the bounds of the rangeE first()
NoSuchElementException
- if this set is emptyE last()
NoSuchElementException
- if this set is emptydefault Spliterator<E> spliterator()
Spliterator
over the elements in this sorted set. The Spliterator
reports Spliterator.DISTINCT
, Spliterator.SORTED
and Spliterator.ORDERED
. Implementations should document the reporting of additional characteristic values.
The spliterator's comparator (see Spliterator.getComparator()
) must be null
if the sorted set's comparator (see comparator()
) is null
. Otherwise, the spliterator's comparator must be the same as or impose the same total ordering as the sorted set's comparator.
spliterator
in interface Collection<E>
spliterator
in interface Iterable<E>
spliterator
in interface Set<E>
Iterator
. The spliterator inherits the fail-fast properties of the set's iterator. The spliterator's comparator is the same as the sorted set's comparator. The created Spliterator
additionally reports Spliterator.SIZED
.
Spliterator
additionally reports Spliterator.SUBSIZED
.Spliterator
over the elements in this sorted setdefault void addFirst(E e)
UnsupportedOperationException
. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.addFirst
in interface SequencedCollection<E>
UnsupportedOperationException
.e
- the element to be addedUnsupportedOperationException
- alwaysdefault void addLast(E e)
UnsupportedOperationException
. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.addLast
in interface SequencedCollection<E>
UnsupportedOperationException
.e
- the element to be added.UnsupportedOperationException
- alwaysdefault E getFirst()
getFirst
in interface SequencedCollection<E>
first
method.NoSuchElementException
- if this collection is emptydefault E getLast()
getLast
in interface SequencedCollection<E>
last
method.NoSuchElementException
- if this collection is emptydefault E removeFirst()
removeFirst
in interface SequencedCollection<E>
first
method to obtain the first element, then it calls remove(element)
to remove the element, and then it returns the element.NoSuchElementException
- if this collection is emptyUnsupportedOperationException
- if this collection implementation does not support this operationdefault E removeLast()
removeLast
in interface SequencedCollection<E>
last
method to obtain the last element, then it calls remove(element)
to remove the element, and then it returns the element.NoSuchElementException
- if this collection is emptyUnsupportedOperationException
- if this collection implementation does not support this operationdefault SortedSet<E> reversed()
reversed
in interface SequencedCollection<E>
reversed
in interface SequencedSet<E>
reversed()
method of the view returns a reference to this SortedSet. Other operations on the view are implemented via calls to public methods on this SortedSet. The exact relationship between calls on the view and calls on this SortedSet is unspecified. However, order-sensitive operations generally delegate to the appropriate method with the opposite orientation. For example, calling getFirst
on the view results in a call to getLast
on this SortedSet.SortedSet
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/SortedSet.html