Modifier and Type	Class and Description
pack-priv class	ReverseOrderSortedSetView.Subset Used for various subset views.

Modifier and Type	Field and Description
pack-priv final SortedSet<E>	base
pack-priv final Comparator<? super E>	comp

Access	Constructor and Description
private	ReverseOrderSortedSetView(SortedSet<E> set)

Method Summary

Modifier and Type	Method and Description
public boolean	add(E e) Implements java.util.Set.add, java.util.Collection.add. Adds the specified element to this set if it is not already present (optional operation).
public boolean	addAll(Collection<? extends E> c) Implements java.util.Set.addAll, java.util.Collection.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
public void	clear() Implements java.util.Set.clear, java.util.Collection.clear. Removes all of the elements from this set (optional operation).
public Comparator<? super E>	comparator() Implements java.util.SortedSet.comparator. Returns the comparator used to order the elements in this set, or `null` if this set uses the natural ordering of its elements.
public boolean	contains(Object o) Implements java.util.Set.contains, java.util.Collection.contains. Returns `true` if this set contains the specified element.
public boolean	containsAll(Collection<?> c) Implements java.util.Set.containsAll, java.util.Collection.containsAll. Returns `true` if this set contains all of the elements of the specified collection.
pack-priv static <T> Iterator<T>	descendingIterator(SortedSet<T> set)
public boolean	equals(Object o) Overrides java.lang.Object.equals. Implements java.util.Set.equals, java.util.Collection.equals. Compares the specified object with this set for equality.
public E	first() Implements java.util.SortedSet.first. Returns the first (lowest) element currently in this set.
public void	forEach(Consumer<? super E> action) Overrides default java.lang.Iterable.forEach. Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode, java.util.Collection.hashCode. Returns the hash code value for this set.
public SortedSet<E>	headSet(E to) Implements java.util.SortedSet.headSet. Returns a view of the portion of this set whose elements are strictly less than `toElement`.
public boolean	isEmpty() Implements java.util.Set.isEmpty, java.util.Collection.isEmpty. Returns `true` if this set contains no elements.
public Iterator<E>	iterator() Implements java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set.
public E	last() Implements java.util.SortedSet.last. Returns the last (highest) element currently in this set.
public static <T> SortedSet<T>	of(SortedSet<T> set) Hides java.util.Set.of. Returns an unmodifiable set containing one element.
public Stream<E>	parallelStream() Overrides default java.util.Collection.parallelStream. Returns a possibly parallel `Stream` with this collection as its source.
public boolean	remove(Object o) Implements java.util.Set.remove, java.util.Collection.remove. Removes the specified element from this set if it is present (optional operation).
public boolean	removeAll(Collection<?> c) Implements java.util.Set.removeAll, java.util.Collection.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation).
public boolean	retainAll(Collection<?> c) Implements java.util.Set.retainAll, java.util.Collection.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation).
public int	size() Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set (its cardinality).
public Spliterator<E>	spliterator() Overrides default java.util.SortedSet.spliterator. Creates a `Spliterator` over the elements in this sorted set.
public Stream<E>	stream() Overrides default java.util.Collection.stream. Returns a sequential `Stream` with this collection as its source.
public SortedSet<E>	subSet(E from, E to) Implements java.util.SortedSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive.
public SortedSet<E>	tailSet(E from) Implements java.util.SortedSet.tailSet. Returns a view of the portion of this set whose elements are greater than or equal to `fromElement`.
public Object[]	toArray() Implements java.util.Set.toArray, java.util.Collection.toArray. Returns an array containing all of the elements in this set.
public <T> T[]	toArray(T[] a) Implements java.util.Set.toArray, java.util.Collection.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.
public <T> T[]	toArray(IntFunction<T[]> generator) Overrides default java.util.Collection.toArray. Returns an array containing all of the elements in this collection, using the provided `generator` function to allocate the returned array.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

base	back to summary
pack-priv final SortedSet<E> base

comp	back to summary
pack-priv final Comparator<? super E> comp

Constructor Detail

ReverseOrderSortedSetView	back to summary
private ReverseOrderSortedSetView(SortedSet<E> set)

Method Detail

add back to summary

add	back to summary
public boolean add(E e) Implements java.util.Set.add, java.util.Collection.add. Doc from java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element `e` to this set if the set contains no element `e2` such that `Objects.equals(e, e2)`. If this set already contains the element, the call leaves the set unchanged and returns `false`. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including `null`, and throw an exception, as described in the specification for `Collection.add`. Individual set implementations should clearly document any restrictions on the elements that they may contain.

public boolean add(E e)

Implements java.util.Set.add, java.util.Collection.add.

Doc from java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

addAll back to summary

addAll	back to summary
public boolean addAll(Collection<? extends E> c) Implements java.util.Set.addAll, java.util.Collection.addAll. Doc from java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the `addAll` operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

public boolean addAll(Collection<? extends E> c)

Implements java.util.Set.addAll, java.util.Collection.addAll.

Doc from java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

clear	back to summary
public void clear() Implements java.util.Set.clear, java.util.Collection.clear. Doc from java.util.Set.clear. Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

clear

back to summary

public void clear()

Implements java.util.Set.clear, java.util.Collection.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

comparator back to summary

comparator	back to summary
public Comparator<? super E> comparator() Implements java.util.SortedSet.comparator. Doc from java.util.SortedSet.comparator. Returns the comparator used to order the elements in this set, or `null` if this set uses the natural ordering of its elements.

public Comparator<? super E> comparator()

Implements java.util.SortedSet.comparator.

Doc from java.util.SortedSet.comparator.

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

contains back to summary

contains	back to summary
public boolean contains(Object o) Implements java.util.Set.contains, java.util.Collection.contains. Doc from java.util.Set.contains. Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `Objects.equals(o, e)`.

public boolean contains(Object o)

Implements java.util.Set.contains, java.util.Collection.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

containsAll back to summary

containsAll	back to summary
public boolean containsAll(Collection<?> c) Implements java.util.Set.containsAll, java.util.Collection.containsAll. Doc from java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns `true` if it is a subset of this set.

public boolean containsAll(Collection<?> c)

Implements java.util.Set.containsAll, java.util.Collection.containsAll.

Doc from java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

descendingIterator	back to summary
pack-priv static <T> Iterator<T> descendingIterator(SortedSet<T> set)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Implements java.util.Set.equals, java.util.Collection.equals. Doc from java.util.Set.equals. Compares the specified object with this set for equality. Returns `true` if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements java.util.Set.equals, java.util.Collection.equals.

Doc from java.util.Set.equals.

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

first	back to summary
public E first() Implements java.util.SortedSet.first. Doc from java.util.SortedSet.first. Returns the first (lowest) element currently in this set.

first

back to summary

public E first()

Implements java.util.SortedSet.first.

Doc from java.util.SortedSet.first.

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

forEach back to summary

forEach	back to summary
public void forEach(Consumer<? super E> action) Overrides default java.lang.Iterable.forEach. Doc from java.lang.Iterable.forEach. Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller. The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.

public void forEach(Consumer<? super E> action)

Overrides default java.lang.Iterable.forEach.

Doc from java.lang.Iterable.forEach.

Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode, java.util.Collection.hashCode. Doc from java.util.Set.hashCode. Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a `null` element is defined to be zero. This ensures that `s1.equals(s2)` implies that `s1.hashCode()==s2.hashCode()` for any two sets `s1` and `s2`, as required by the general contract of `Object#hashCode`.

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Set.hashCode, java.util.Collection.hashCode.

Doc from java.util.Set.hashCode.

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object#hashCode.

headSet back to summary

headSet	back to summary
public SortedSet<E> headSet(E to) Implements java.util.SortedSet.headSet. Doc from java.util.SortedSet.headSet. 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.

public SortedSet<E> headSet(E to)

Implements java.util.SortedSet.headSet.

Doc from java.util.SortedSet.headSet.

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.

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Set.isEmpty, java.util.Collection.isEmpty. Doc from java.util.Set.isEmpty. Returns `true` if this set contains no elements.

public boolean isEmpty()

Implements java.util.Set.isEmpty, java.util.Collection.isEmpty.

Doc from java.util.Set.isEmpty.

Returns true if this set contains no elements.

iterator	back to summary
public Iterator<E> iterator() Implements java.util.Set.iterator, java.util.Collection.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

iterator

back to summary

public Iterator<E> iterator()

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

last	back to summary
public E last() Implements java.util.SortedSet.last. Doc from java.util.SortedSet.last. Returns the last (highest) element currently in this set.

last

back to summary

public E last()

Implements java.util.SortedSet.last.

Doc from java.util.SortedSet.last.

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

of	back to summary
public static <T> SortedSet<T> of(SortedSet<T> set) Hides java.util.Set.of. Doc from java.util.Set.of. Returns an unmodifiable set containing one element. See Unmodifiable Sets for details.

back to summary

public static <T> SortedSet<T> of(SortedSet<T> set)

Hides java.util.Set.of.

Doc from java.util.Set.of.

Returns an unmodifiable set containing one element. See Unmodifiable Sets for details.

parallelStream back to summary

parallelStream	back to summary
public Stream<E> parallelStream() Overrides default java.util.Collection.parallelStream. Doc from java.util.Collection.parallelStream. Returns a possibly parallel `Stream` with this collection as its source. It is allowable for this method to return a sequential stream. This method should be overridden when the `spliterator()` method cannot return a spliterator that is `IMMUTABLE`, `CONCURRENT`, or late-binding. (See `spliterator()` for details.)

public Stream<E> parallelStream()

Overrides default java.util.Collection.parallelStream.

Doc from java.util.Collection.parallelStream.

Returns a possibly parallel Stream with this collection as its source. It is allowable for this method to return a sequential stream.

This method should be overridden when the spliterator() method cannot return a spliterator that is IMMUTABLE, CONCURRENT, or late-binding. (See spliterator() for details.)

remove back to summary

remove	back to summary
public boolean remove(Object o) Implements java.util.Set.remove, java.util.Collection.remove. Doc from java.util.Set.remove. Removes the specified element from this set if it is present (optional operation). More formally, removes an element `e` such that `Objects.equals(o, e)`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

public boolean remove(Object o)

Implements java.util.Set.remove, java.util.Collection.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

removeAll	back to summary
public boolean removeAll(Collection<?> c) Implements java.util.Set.removeAll, java.util.Collection.removeAll. Doc from java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

removeAll

back to summary

public boolean removeAll(Collection<?> c)

Implements java.util.Set.removeAll, java.util.Collection.removeAll.

Doc from java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

retainAll	back to summary
public boolean retainAll(Collection<?> c) Implements java.util.Set.retainAll, java.util.Collection.retainAll. Doc from java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

retainAll

back to summary

public boolean retainAll(Collection<?> c)

Implements java.util.Set.retainAll, java.util.Collection.retainAll.

Doc from java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

size back to summary

size	back to summary
public int size() Implements java.util.Set.size, java.util.Collection.size. Doc from java.util.Set.size. Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`.

public int size()

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

spliterator back to summary

spliterator	back to summary
public Spliterator<E> spliterator() Overrides default java.util.SortedSet.spliterator. Doc from java.util.SortedSet.spliterator. Creates a `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 `java.util.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.

public Spliterator<E> spliterator()

Overrides default java.util.SortedSet.spliterator.

Doc from java.util.SortedSet.spliterator.

Creates a 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 java.util.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.

stream back to summary

stream	back to summary
public Stream<E> stream() Overrides default java.util.Collection.stream. Doc from java.util.Collection.stream. Returns a sequential `Stream` with this collection as its source. This method should be overridden when the `spliterator()` method cannot return a spliterator that is `IMMUTABLE`, `CONCURRENT`, or late-binding. (See `spliterator()` for details.)

public Stream<E> stream()

Overrides default java.util.Collection.stream.

Doc from java.util.Collection.stream.

Returns a sequential Stream with this collection as its source.

This method should be overridden when the spliterator() method cannot return a spliterator that is IMMUTABLE, CONCURRENT, or late-binding. (See spliterator() for details.)

subSet back to summary

subSet	back to summary
public SortedSet<E> subSet(E from, E to) Implements java.util.SortedSet.subSet. Doc from java.util.SortedSet.subSet. 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.

public SortedSet<E> subSet(E from, E to)

Implements java.util.SortedSet.subSet.

Doc from java.util.SortedSet.subSet.

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.

tailSet back to summary

tailSet	back to summary
public SortedSet<E> tailSet(E from) Implements java.util.SortedSet.tailSet. Doc from java.util.SortedSet.tailSet. 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.

public SortedSet<E> tailSet(E from)

Implements java.util.SortedSet.tailSet.

Doc from java.util.SortedSet.tailSet.

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.

toArray	back to summary
public Object[] toArray() Implements java.util.Set.toArray, java.util.Collection.toArray. Doc from java.util.Set.toArray. Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array. This method acts as bridge between array-based and collection-based APIs.

toArray

back to summary

public Object[] toArray()

Implements java.util.Set.toArray, java.util.Collection.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

toArray back to summary

toArray	back to summary
public <T> T[] toArray(T[] a) Implements java.util.Set.toArray, java.util.Collection.toArray. Doc from java.util.Set.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set. If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to `null`. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.) If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. Like the `toArray()` method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs. Suppose `x` is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of `String`: String[] y = x.toArray(new String[0]); Note that `toArray(new Object[0])` is identical in function to `toArray()`.

public <T> T[] toArray(T[] a)

Implements java.util.Set.toArray, java.util.Collection.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of String:

    String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

toArray back to summary

toArray	back to summary
public <T> T[] toArray(IntFunction<T[]> generator) Overrides default java.util.Collection.toArray. Doc from java.util.Collection.toArray. Returns an array containing all of the elements in this collection, using the provided `generator` function to allocate the returned array. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

public <T> T[] toArray(IntFunction<T[]> generator)

Overrides default java.util.Collection.toArray.

Doc from java.util.Collection.toArray.

Returns an array containing all of the elements in this collection, using the provided generator function to allocate the returned array.

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

java.util back to summary

pack-priv Class ReverseOrderSortedSetView.Subset

Class Inheritance

extends AbstractSet<E>
implements SortedSet<E>

java.lang.Object
java.util.AbstractCollection
java.util.AbstractSet
java.util.ReverseOrderSortedSetView.Subset

All Implemented Interfaces

java.util.SortedSet, java.util.SequencedSet, java.util.Set, java.util.Collection, java.lang.Iterable, java.util.SequencedCollection

Used for various subset views. We can't use the base SortedSet's subset, because of the asymmetry between from-inclusive and to-exclusive.

Field Summary

Modifier and Type	Field and Description
pack-priv final Comparator<E>	cmp
pack-priv final E	head
pack-priv final E	tail

Constructor Summary

Access	Constructor and Description
pack-priv	Subset(E head, E tail)

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	aboveHead(E e)
public boolean	add(E e) Overrides java.util.AbstractCollection.add. Implements java.util.Set.add, java.util.Collection.add. Adds the specified element to this set if it is not already present (optional operation).
pack-priv boolean	belowTail(E e)
public Comparator<? super E>	comparator() Implements java.util.SortedSet.comparator. Returns the comparator used to order the elements in this set, or `null` if this set uses the natural ordering of its elements.
public E	first() Implements java.util.SortedSet.first. Returns the first (lowest) element currently in this set.
public SortedSet<E>	headSet(E to) Implements java.util.SortedSet.headSet. Returns a view of the portion of this set whose elements are strictly less than `toElement`.
public Iterator<E>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set.
public E	last() Implements java.util.SortedSet.last. Returns the last (highest) element currently in this set.
public boolean	remove(Object o) Overrides java.util.AbstractCollection.remove. Implements java.util.Set.remove, java.util.Collection.remove. Removes the specified element from this set if it is present (optional operation).
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set (its cardinality).
public SortedSet<E>	subSet(E from, E to) Implements java.util.SortedSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive.
public SortedSet<E>	tailSet(E from) Implements java.util.SortedSet.tailSet. Returns a view of the portion of this set whose elements are greater than or equal to `fromElement`.

Inherited from java.util.AbstractSet:: equals hashCode removeAll

Field Detail

cmp	back to summary
pack-priv final Comparator<E> cmp

head	back to summary
pack-priv final E head

tail	back to summary
pack-priv final E tail

Constructor Detail

Subset	back to summary
pack-priv Subset(E head, E tail) Annotations @SuppressWarnings:unchecked

Method Detail

aboveHead	back to summary
pack-priv boolean aboveHead(E e)

add back to summary

add	back to summary
public boolean add(E e) Overrides java.util.AbstractCollection.add. Implements java.util.Set.add, java.util.Collection.add. Doc from java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element `e` to this set if the set contains no element `e2` such that `Objects.equals(e, e2)`. If this set already contains the element, the call leaves the set unchanged and returns `false`. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including `null`, and throw an exception, as described in the specification for `Collection.add`. Individual set implementations should clearly document any restrictions on the elements that they may contain.

public boolean add(E e)

Overrides java.util.AbstractCollection.add.

Implements java.util.Set.add, java.util.Collection.add.

Doc from java.util.Set.add.

belowTail	back to summary
pack-priv boolean belowTail(E e)

comparator back to summary

comparator	back to summary
public Comparator<? super E> comparator() Implements java.util.SortedSet.comparator. Doc from java.util.SortedSet.comparator. Returns the comparator used to order the elements in this set, or `null` if this set uses the natural ordering of its elements.

public Comparator<? super E> comparator()

Implements java.util.SortedSet.comparator.

Doc from java.util.SortedSet.comparator.

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

first	back to summary
public E first() Implements java.util.SortedSet.first. Doc from java.util.SortedSet.first. Returns the first (lowest) element currently in this set.

first

back to summary

public E first()

Implements java.util.SortedSet.first.

Doc from java.util.SortedSet.first.

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

headSet back to summary

headSet	back to summary
public SortedSet<E> headSet(E to) Implements java.util.SortedSet.headSet. Doc from java.util.SortedSet.headSet. 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.

public SortedSet<E> headSet(E to)

Implements java.util.SortedSet.headSet.

Doc from java.util.SortedSet.headSet.

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

iterator	back to summary
public Iterator<E> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

iterator

back to summary

public Iterator<E> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

last

back to summary

public E last()

Implements java.util.SortedSet.last.

Doc from java.util.SortedSet.last.

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

remove back to summary

public boolean remove(Object o)

Overrides java.util.AbstractCollection.remove.

Implements java.util.Set.remove, java.util.Collection.remove.

Doc from java.util.Set.remove.

size back to summary

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

subSet back to summary

public SortedSet<E> subSet(E from, E to)

Implements java.util.SortedSet.subSet.

Doc from java.util.SortedSet.subSet.

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

tailSet back to summary

public SortedSet<E> tailSet(E from)

Implements java.util.SortedSet.tailSet.

Doc from java.util.SortedSet.tailSet.

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