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>, SequencedCollection<E>, SequencedSet<E>, Set<E>, SortedSet<E>

Enclosing class:

ForwardingNavigableSet<E extends @Nullable Object>

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

Author:

Louis Wasserman

Nested Class Summary

Nested classes/interfaces inherited from class ForwardingNavigableSet

ForwardingNavigableSet.StandardDescendingSet

Modifier and Type	Class	Description
protected class	ForwardingNavigableSet.StandardDescendingSet	A sensible implementation of NavigableSet.descendingSet() in terms of the other methods of NavigableSet, notably including NavigableSet.descendingIterator().

Constructor Summary

Constructors

Constructor	Description
StandardDescendingSet()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
E	ceiling(E e)
Comparator<? super E>	comparator()
protected NavigableSet<E>	delegate()	Returns the backing delegate instance that methods are forwarded to.
Iterator<E>	descendingIterator()
NavigableSet<E>	descendingSet()
E	first()
E	floor(E e)
SortedSet<E>	headSet(E toElement)
NavigableSet<E>	headSet(E toElement, boolean inclusive)
E	higher(E e)
Iterator<E>	iterator()
E	last()
E	lower(E e)
E	pollFirst()
E	pollLast()
NavigableSet<E>	subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
SortedSet<E>	subSet(E fromElement, E toElement)
SortedSet<E>	tailSet(E fromElement)
NavigableSet<E>	tailSet(E fromElement, boolean inclusive)
@Nullable Object[]	toArray()
<T extends @Nullable Object> T[]	toArray(T[] array)
String	toString()	Returns the string representation generated by the delegate's toString method.

Methods inherited from class ForwardingNavigableSet

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

Modifier and Type	Method	Description
protected E	standardCeiling(E e)	A sensible definition of ForwardingNavigableSet.ceiling(E) in terms of the iterator method of ForwardingNavigableSet.tailSet(Object, boolean).
protected E	standardFirst()
protected E	standardFloor(E e)	A sensible definition of ForwardingNavigableSet.floor(E) in terms of the descendingIterator method of ForwardingNavigableSet.headSet(Object, boolean).
protected SortedSet<E>	standardHeadSet(E toElement)	A sensible definition of ForwardingSortedSet.headSet(Object) in terms of the ForwardingNavigableSet.headSet(Object, boolean) method.
protected E	standardHigher(E e)	A sensible definition of ForwardingNavigableSet.higher(E) in terms of the iterator method of ForwardingNavigableSet.tailSet(Object, boolean).
protected E	standardLast()
protected E	standardLower(E e)	A sensible definition of ForwardingNavigableSet.lower(E) in terms of the descendingIterator method of ForwardingNavigableSet.headSet(Object, boolean).
protected E	standardPollFirst()	A sensible definition of ForwardingNavigableSet.pollFirst() in terms of the iterator method.
protected E	standardPollLast()	A sensible definition of ForwardingNavigableSet.pollLast() in terms of the descendingIterator method.
protected NavigableSet<E>	standardSubSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)	A sensible definition of ForwardingNavigableSet.subSet(Object, boolean, Object, boolean) in terms of the headSet and tailSet methods.
protected SortedSet<E>	standardSubSet(E fromElement, E toElement)	A sensible definition of ForwardingSortedSet.subSet(Object, Object) in terms of the ForwardingNavigableSet.subSet(Object, boolean, Object, boolean) method.
protected SortedSet<E>	standardTailSet(E fromElement)	A sensible definition of ForwardingSortedSet.tailSet(Object) in terms of the ForwardingNavigableSet.tailSet(Object, boolean) method.

Methods inherited from class ForwardingSortedSet

standardContains, standardRemove

Modifier and Type	Method	Description
protected boolean	standardContains(@Nullable Object object)	A sensible definition of ForwardingCollection.contains(Object) in terms of the first() method of ForwardingSortedSet.tailSet(E).
protected boolean	standardRemove(@Nullable Object object)	A sensible definition of ForwardingCollection.remove(Object) in terms of the iterator() method of ForwardingSortedSet.tailSet(E).

Methods inherited from class ForwardingSet

equals, hashCode, standardEquals, standardHashCode, standardRemoveAll

Modifier and Type	Method	Description
boolean	equals(@Nullable Object object)
int	hashCode()
protected boolean	standardEquals(@Nullable Object object)	A sensible definition of ForwardingSet.equals(Object) in terms of ForwardingCollection.size() and ForwardingCollection.containsAll(Collection).
protected int	standardHashCode()	A sensible definition of ForwardingSet.hashCode() in terms of ForwardingCollection.iterator().
protected boolean	standardRemoveAll(Collection<?> collection)	A sensible definition of ForwardingCollection.removeAll(Collection) in terms of ForwardingCollection.iterator() and ForwardingCollection.remove(Object).

Methods inherited from class ForwardingCollection

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

Modifier and Type	Method	Description
boolean	add(E element)
boolean	addAll(Collection<? extends E> collection)
void	clear()
boolean	contains(@Nullable Object object)
boolean	containsAll(Collection<?> collection)
boolean	isEmpty()
boolean	remove(@Nullable Object object)
boolean	removeAll(Collection<?> collection)
boolean	retainAll(Collection<?> collection)
int	size()
protected boolean	standardAddAll(Collection<? extends E> collection)	A sensible definition of ForwardingCollection.addAll(Collection) in terms of ForwardingCollection.add(E).
protected void	standardClear()	A sensible definition of ForwardingCollection.clear() in terms of ForwardingCollection.iterator(), using the iterator's remove method.
protected boolean	standardContainsAll(Collection<?> collection)	A sensible definition of ForwardingCollection.containsAll(Collection) in terms of ForwardingCollection.contains(Object) .
protected boolean	standardIsEmpty()	A sensible definition of ForwardingCollection.isEmpty() as !iterator().hasNext.
protected boolean	standardRetainAll(Collection<?> collection)	A sensible definition of ForwardingCollection.retainAll(Collection) in terms of ForwardingCollection.iterator(), using the iterator's remove method.
protected @Nullable Object[]	standardToArray()	A sensible definition of ForwardingCollection.toArray() in terms of ForwardingCollection.toArray(Object[]).
protected <T extends @Nullable Object> T[]	standardToArray(T[] array)	A sensible definition of ForwardingCollection.toArray(Object[]) in terms of ForwardingCollection.size() and ForwardingCollection.iterator().
protected String	standardToString()	A sensible definition of ForwardingObject.toString() in terms of ForwardingCollection.iterator().

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface NavigableSet

removeFirst, removeLast, reversed

Methods inherited from interface Set

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

Methods inherited from interface SortedSet

addFirst, addLast, getFirst, getLast, spliterator

Constructor Details

StandardDescendingSet

public StandardDescendingSet()

Constructor for use by subclasses.

Method Details

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 extends @Nullable Object>

lower

public E lower(E e)

Specified by:

lower in interface NavigableSet<E extends @Nullable Object>

Overrides:

lower in class ForwardingNavigableSet<E extends @Nullable Object>

floor

public E floor(E e)

Specified by:

floor in interface NavigableSet<E extends @Nullable Object>

Overrides:

floor in class ForwardingNavigableSet<E extends @Nullable Object>

ceiling

public E ceiling(E e)

Specified by:

ceiling in interface NavigableSet<E extends @Nullable Object>

Overrides:

ceiling in class ForwardingNavigableSet<E extends @Nullable Object>

higher

public E higher(E e)

Specified by:

higher in interface NavigableSet<E extends @Nullable Object>

Overrides:

higher in class ForwardingNavigableSet<E extends @Nullable Object>

pollFirst

public E pollFirst()

Specified by:

pollFirst in interface NavigableSet<E extends @Nullable Object>

Overrides:

pollFirst in class ForwardingNavigableSet<E extends @Nullable Object>

pollLast

public E pollLast()

Specified by:

pollLast in interface NavigableSet<E extends @Nullable Object>

Overrides:

pollLast in class ForwardingNavigableSet<E extends @Nullable Object>

descendingSet

public NavigableSet<E> descendingSet()

Specified by:

descendingSet in interface NavigableSet<E extends @Nullable Object>

Overrides:

descendingSet in class ForwardingNavigableSet<E extends @Nullable Object>

descendingIterator

public Iterator<E> descendingIterator()

Specified by:

descendingIterator in interface NavigableSet<E extends @Nullable Object>

Overrides:

descendingIterator in class ForwardingNavigableSet<E extends @Nullable Object>

subSet

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

Specified by:

subSet in interface NavigableSet<E extends @Nullable Object>

Overrides:

subSet in class ForwardingNavigableSet<E extends @Nullable Object>

subSet

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

Specified by:

subSet in interface NavigableSet<E extends @Nullable Object>

Specified by:

subSet in interface SortedSet<E extends @Nullable Object>

Overrides:

subSet in class ForwardingSortedSet<E extends @Nullable Object>

headSet

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

Specified by:

headSet in interface NavigableSet<E extends @Nullable Object>

Overrides:

headSet in class ForwardingNavigableSet<E extends @Nullable Object>

headSet

public SortedSet<E> headSet(E toElement)

Specified by:

headSet in interface NavigableSet<E extends @Nullable Object>

Specified by:

headSet in interface SortedSet<E extends @Nullable Object>

Overrides:

headSet in class ForwardingSortedSet<E extends @Nullable Object>

tailSet

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

Specified by:

tailSet in interface NavigableSet<E extends @Nullable Object>

Overrides:

tailSet in class ForwardingNavigableSet<E extends @Nullable Object>

tailSet

public SortedSet<E> tailSet(E fromElement)

Specified by:

tailSet in interface NavigableSet<E extends @Nullable Object>

Specified by:

tailSet in interface SortedSet<E extends @Nullable Object>

Overrides:

tailSet in class ForwardingSortedSet<E extends @Nullable Object>

comparator

public Comparator<? super E> comparator()

Specified by:

comparator in interface SortedSet<E extends @Nullable Object>

Overrides:

comparator in class ForwardingSortedSet<E extends @Nullable Object>

first

public E first()

Specified by:

first in interface SortedSet<E extends @Nullable Object>

Overrides:

first in class ForwardingSortedSet<E extends @Nullable Object>

last

public E last()

Specified by:

last in interface SortedSet<E extends @Nullable Object>

Overrides:

last in class ForwardingSortedSet<E extends @Nullable Object>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E extends @Nullable Object>

Specified by:

iterator in interface Iterable<E extends @Nullable Object>

Specified by:

iterator in interface NavigableSet<E extends @Nullable Object>

Specified by:

iterator in interface Set<E extends @Nullable Object>

Overrides:

iterator in class ForwardingCollection<E extends @Nullable Object>

toArray

public @Nullable Object[] toArray()

Specified by:

toArray in interface Collection<E extends @Nullable Object>

Specified by:

toArray in interface Set<E extends @Nullable Object>

Overrides:

toArray in class ForwardingCollection<E extends @Nullable Object>

toArray

public <T extends @Nullable Object> T[] toArray(T[] array)

Specified by:

toArray in interface Collection<E extends @Nullable Object>

Specified by:

toArray in interface Set<E extends @Nullable Object>

Overrides:

toArray in class ForwardingCollection<E extends @Nullable Object>

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