Package com.google.common.collect

Class ForwardingNavigableSet.StandardDescendingSet

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingCollection<E>

com.google.common.collect.ForwardingSet<E>

com.google.common.collect.ForwardingSortedSet<E>

com.google.common.collect.ForwardingNavigableSet<E>

com.google.common.collect.ForwardingNavigableSet.StandardDescendingSet

All Implemented Interfaces:

Iterable<E>, Collection<E>, NavigableSet<E>, Set<E>, SortedSet<E>

Enclosing class:

ForwardingNavigableSet<E>

@Beta
protected class ForwardingNavigableSet.StandardDescendingSet
extends ForwardingNavigableSet<E>

A sensible implementation of NavigableSet.descendingSet() in terms of the other methods of NavigableSet, notably including NavigableSet.descendingIterator().

In many cases, you may wish to override ForwardingNavigableSet.descendingSet() to forward to this implementation or a subclass thereof.

Since:

12.0

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.collect.ForwardingNavigableSet

ForwardingNavigableSet.StandardDescendingSet

Constructor Summary

Constructors

Constructor	Description
StandardDescendingSet()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
E	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.
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.
protected NavigableSet<E>	delegate()	Returns the backing delegate instance that methods are forwarded to.
Iterator<E>	descendingIterator()	Returns an iterator over the elements in this set, in descending order.
NavigableSet<E>	descendingSet()	Returns a reverse order view of the elements contained in this set.
E	first()	Returns the first (lowest) element currently in this set.
E	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.
SortedSet<E>	headSet(E toElement)	Returns a view of the portion of this set whose elements are strictly less than toElement.
NavigableSet<E>	headSet(E toElement, boolean inclusive)	Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement.
E	higher(E e)	Returns the least element in this set strictly greater than the given element, or null if there is no such element.
Iterator<E>	iterator()	Returns an iterator over the elements in this collection.
E	last()	Returns the last (highest) element currently in this set.
E	lower(E e)	Returns the greatest element in this set strictly less than the given element, or null if there is no such element.
E	pollFirst()	Retrieves and removes the first (lowest) element, or returns null if this set is empty.
E	pollLast()	Retrieves and removes the last (highest) element, or returns null if this set is empty.
NavigableSet<E>	subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)	Returns a view of the portion of this set whose elements range from fromElement to toElement.
SortedSet<E>	subSet(E fromElement, E toElement)	Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.
SortedSet<E>	tailSet(E fromElement)	Returns a view of the portion of this set whose elements are greater than or equal to fromElement.
NavigableSet<E>	tailSet(E fromElement, boolean inclusive)	Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement.
Object[]	toArray()	Returns an array containing all of the elements in this collection.
<T> T[]	toArray(T[] array)	Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
String	toString()	Returns the string representation generated by the delegate's toString method.

Methods inherited from class com.google.common.collect.ForwardingNavigableSet

standardCeiling, standardFirst, standardFloor, standardHeadSet, standardHigher, standardLast, standardLower, standardPollFirst, standardPollLast, standardSubSet, standardSubSet, standardTailSet

Methods inherited from class com.google.common.collect.ForwardingSortedSet

standardContains, standardRemove

Methods inherited from class com.google.common.collect.ForwardingSet

equals, hashCode, standardEquals, standardHashCode, standardRemoveAll

Methods inherited from class com.google.common.collect.ForwardingCollection

add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContainsAll, standardIsEmpty, standardRetainAll, standardToArray, standardToArray, standardToString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Detail

StandardDescendingSet

public StandardDescendingSet()

Constructor for use by subclasses.

Method Detail

delegate

protected NavigableSet<E> delegate()

Description copied from class: ForwardingObject

Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingNavigableSet<E>

lower

public E lower(E e)

Description copied from interface: java.util.NavigableSet

Returns the greatest element in this set strictly less than the given element, or null if there is no such element.

Specified by:

lower in interface NavigableSet<E>

Overrides:

lower in class ForwardingNavigableSet<E>

Parameters:

e - the value to match

Returns:

the greatest element less than e, or null if there is no such element

floor

public E floor(E e)

Description copied from interface: java.util.NavigableSet

Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.

Specified by:

floor in interface NavigableSet<E>

Overrides:

floor in class ForwardingNavigableSet<E>

Parameters:

e - the value to match

Returns:

the greatest element less than or equal to e, or null if there is no such element

ceiling

public E ceiling(E e)

Description copied from interface: java.util.NavigableSet

Returns the least element in this set greater than or equal to the given element, or null if there is no such element.

Specified by:

ceiling in interface NavigableSet<E>

Overrides:

ceiling in class ForwardingNavigableSet<E>

Parameters:

e - the value to match

Returns:

the least element greater than or equal to e, or null if there is no such element

higher

public E higher(E e)

Description copied from interface: java.util.NavigableSet

Returns the least element in this set strictly greater than the given element, or null if there is no such element.

Specified by:

higher in interface NavigableSet<E>

Overrides:

higher in class ForwardingNavigableSet<E>

Parameters:

e - the value to match

Returns:

the least element greater than e, or null if there is no such element

pollFirst

public E pollFirst()

Description copied from interface: java.util.NavigableSet

Retrieves and removes the first (lowest) element, or returns null if this set is empty.

Specified by:

pollFirst in interface NavigableSet<E>

Overrides:

pollFirst in class ForwardingNavigableSet<E>

Returns:

the first element, or null if this set is empty

pollLast

public E pollLast()

Description copied from interface: java.util.NavigableSet

Retrieves and removes the last (highest) element, or returns null if this set is empty.

Specified by:

pollLast in interface NavigableSet<E>

Overrides:

pollLast in class ForwardingNavigableSet<E>

Returns:

the last element, or null if this set is empty

descendingSet

public NavigableSet<E> descendingSet()

Description copied from interface: java.util.NavigableSet

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.

Specified by:

descendingSet in interface NavigableSet<E>

Overrides:

descendingSet in class ForwardingNavigableSet<E>

Returns:

a reverse order view of this set

descendingIterator

public Iterator<E> descendingIterator()

Description copied from interface: java.util.NavigableSet

Returns an iterator over the elements in this set, in descending order. Equivalent in effect to descendingSet().iterator().

Specified by:

descendingIterator in interface NavigableSet<E>

Overrides:

descendingIterator in class ForwardingNavigableSet<E>

Returns:

an iterator over the elements in this set, in descending order

subSet

public NavigableSet<E> subSet(E fromElement,
                              boolean fromInclusive,
                              E toElement,
                              boolean toInclusive)

Description copied from interface: java.util.NavigableSet

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.

Specified by:

subSet in interface NavigableSet<E>

Overrides:

subSet in class ForwardingNavigableSet<E>

Parameters:

fromElement - low endpoint of the returned set

fromInclusive - true if the low endpoint is to be included in the returned view

toElement - high endpoint of the returned set

toInclusive - true if the high endpoint is to be included in the returned view

Returns:

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

subSet

public SortedSet<E> subSet(E fromElement,
                           E toElement)

Description copied from interface: java.util.SortedSet

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.

Specified by:

subSet in interface NavigableSet<E>

Specified by:

subSet in interface SortedSet<E>

Overrides:

subSet in class ForwardingSortedSet<E>

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

headSet

public NavigableSet<E> headSet(E toElement,
                               boolean inclusive)

Description copied from interface: java.util.NavigableSet

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.

Specified by:

headSet in interface NavigableSet<E>

Overrides:

headSet in class ForwardingNavigableSet<E>

Parameters:

toElement - high endpoint of the returned set

inclusive - true if the high endpoint is to be included in the returned view

Returns:

a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement

headSet

public SortedSet<E> headSet(E toElement)

Description copied from interface: java.util.SortedSet

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.

Specified by:

headSet in interface NavigableSet<E>

Specified by:

headSet in interface SortedSet<E>

Overrides:

headSet in class ForwardingSortedSet<E>

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

tailSet

public NavigableSet<E> tailSet(E fromElement,
                               boolean inclusive)

Description copied from interface: java.util.NavigableSet

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.

Specified by:

tailSet in interface NavigableSet<E>

Overrides:

tailSet in class ForwardingNavigableSet<E>

Parameters:

fromElement - low endpoint of the returned set

inclusive - true if the low endpoint is to be included in the returned view

Returns:

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

tailSet

public SortedSet<E> tailSet(E fromElement)

Description copied from interface: java.util.SortedSet

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.

Specified by:

tailSet in interface NavigableSet<E>

Specified by:

tailSet in interface SortedSet<E>

Overrides:

tailSet in class ForwardingSortedSet<E>

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

comparator

public Comparator<? super E> comparator()

Description copied from interface: java.util.SortedSet

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

Specified by:

comparator in interface SortedSet<E>

Overrides:

comparator in class ForwardingSortedSet<E>

Returns:

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

first

public E first()

Description copied from interface: java.util.SortedSet

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

Specified by:

first in interface SortedSet<E>

Overrides:

first in class ForwardingSortedSet<E>

Returns:

the first (lowest) element currently in this set

last

public E last()

Description copied from interface: java.util.SortedSet

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

Specified by:

last in interface SortedSet<E>

Overrides:

last in class ForwardingSortedSet<E>

Returns:

the last (highest) element currently in this set

iterator

public Iterator<E> iterator()

Description copied from interface: java.util.Collection

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface NavigableSet<E>

Specified by:

iterator in interface Set<E>

Overrides:

iterator in class ForwardingCollection<E>

Returns:

an Iterator over the elements in this collection

toArray

public Object[] toArray()

Description copied from interface: java.util.Collection

Returns an array containing all of the elements in this collection. 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. The returned array's runtime component type is Object.

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

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class ForwardingCollection<E>

Returns:

an array, whose runtime component type is Object, containing all of the elements in this collection

toArray

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

Description copied from interface: java.util.Collection

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection 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 collection.

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

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.

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class ForwardingCollection<E>

Type Parameters:

T - the component type of the array to contain the collection

Parameters:

array - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing all of the elements in this collection

toString

public String toString()

Description copied from class: ForwardingObject

Returns the string representation generated by the delegate's toString method.

Overrides:

toString in class ForwardingObject

Returns:

a string representation of the object.