Class ForwardingNavigableSet<E extends @Nullable Object>
- 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>
-
- All Implemented Interfaces:
Iterable<E>
,Collection<E>
,NavigableSet<E>
,Set<E>
,SortedSet<E>
- Direct Known Subclasses:
ForwardingNavigableSet.StandardDescendingSet
@GwtIncompatible public abstract class ForwardingNavigableSet<E extends @Nullable Object> extends ForwardingSortedSet<E> implements NavigableSet<E>
A navigable set which forwards all its method calls to another navigable set. Subclasses should override one or more methods to modify the behavior of the backing set as desired per the decorator pattern.Warning: The methods of
ForwardingNavigableSet
forward indiscriminately to the methods of the delegate. For example, overridingForwardingCollection.add(E)
alone will not change the behavior ofForwardingCollection.addAll(java.util.Collection<? extends E>)
, which can lead to unexpected behavior. In this case, you should overrideaddAll
as well, either providing your own implementation, or delegating to the providedstandardAddAll
method.default
method warning: This class does not forward calls todefault
methods. Instead, it inherits their default implementations. When those implementations invoke methods, they invoke methods on theForwardingNavigableSet
.Each of the
standard
methods uses the set's comparator (or the natural ordering of the elements, if there is no comparator) to test element equality. As a result, if the comparator is not consistent with equals, some of the standard implementations may violate theSet
contract.The
standard
methods and the collection views they return are not guaranteed to be thread-safe, even when all of the methods that they depend on are thread-safe.- Since:
- 12.0
- Author:
- Louis Wasserman
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
ForwardingNavigableSet.StandardDescendingSet
A sensible implementation ofNavigableSet.descendingSet()
in terms of the other methods ofNavigableSet
, notably includingNavigableSet.descendingIterator()
.
-
Constructor Summary
Constructors Modifier Constructor Description protected
ForwardingNavigableSet()
Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description @Nullable E
ceiling(E e)
protected abstract NavigableSet<E>
delegate()
Returns the backing delegate instance that methods are forwarded to.Iterator<E>
descendingIterator()
NavigableSet<E>
descendingSet()
@Nullable E
floor(E e)
NavigableSet<E>
headSet(E toElement, boolean inclusive)
@Nullable E
higher(E e)
@Nullable E
lower(E e)
@Nullable E
pollFirst()
@Nullable E
pollLast()
protected @Nullable E
standardCeiling(E e)
protected E
standardFirst()
protected @Nullable E
standardFloor(E e)
A sensible definition offloor(E)
in terms of thedescendingIterator
method ofheadSet(Object, boolean)
.protected SortedSet<E>
standardHeadSet(E toElement)
A sensible definition ofForwardingSortedSet.headSet(Object)
in terms of theheadSet(Object, boolean)
method.protected @Nullable E
standardHigher(E e)
protected E
standardLast()
protected @Nullable E
standardLower(E e)
A sensible definition oflower(E)
in terms of thedescendingIterator
method ofheadSet(Object, boolean)
.protected @Nullable E
standardPollFirst()
A sensible definition ofpollFirst()
in terms of theiterator
method.protected @Nullable E
standardPollLast()
A sensible definition ofpollLast()
in terms of thedescendingIterator
method.protected NavigableSet<E>
standardSubSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
A sensible definition ofsubSet(Object, boolean, Object, boolean)
in terms of theheadSet
andtailSet
methods.protected SortedSet<E>
standardSubSet(E fromElement, E toElement)
A sensible definition ofForwardingSortedSet.subSet(Object, Object)
in terms of thesubSet(Object, boolean, Object, boolean)
method.protected SortedSet<E>
standardTailSet(E fromElement)
A sensible definition ofForwardingSortedSet.tailSet(Object)
in terms of thetailSet(Object, boolean)
method.NavigableSet<E>
subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
NavigableSet<E>
tailSet(E fromElement, boolean inclusive)
-
Methods inherited from class com.google.common.collect.ForwardingSortedSet
comparator, first, headSet, last, standardContains, standardRemove, subSet, tailSet
-
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, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContainsAll, standardIsEmpty, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray
-
Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
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.util.NavigableSet
headSet, iterator, subSet, tailSet
-
Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray
-
Methods inherited from interface java.util.SortedSet
comparator, first, last, spliterator
-
-
-
-
Constructor Detail
-
ForwardingNavigableSet
protected ForwardingNavigableSet()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract 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 asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegate
in classForwardingSortedSet<E extends @Nullable Object>
-
lower
public @Nullable E lower(E e)
- Specified by:
lower
in interfaceNavigableSet<E extends @Nullable Object>
-
standardLower
protected @Nullable E standardLower(E e)
A sensible definition oflower(E)
in terms of thedescendingIterator
method ofheadSet(Object, boolean)
. If you overrideheadSet(Object, boolean)
, you may wish to overridelower(E)
to forward to this implementation.
-
floor
public @Nullable E floor(E e)
- Specified by:
floor
in interfaceNavigableSet<E extends @Nullable Object>
-
standardFloor
protected @Nullable E standardFloor(E e)
A sensible definition offloor(E)
in terms of thedescendingIterator
method ofheadSet(Object, boolean)
. If you overrideheadSet(Object, boolean)
, you may wish to overridefloor(E)
to forward to this implementation.
-
ceiling
public @Nullable E ceiling(E e)
- Specified by:
ceiling
in interfaceNavigableSet<E extends @Nullable Object>
-
standardCeiling
protected @Nullable E standardCeiling(E e)
A sensible definition ofceiling(E)
in terms of theiterator
method oftailSet(Object, boolean)
. If you overridetailSet(Object, boolean)
, you may wish to overrideceiling(E)
to forward to this implementation.
-
higher
public @Nullable E higher(E e)
- Specified by:
higher
in interfaceNavigableSet<E extends @Nullable Object>
-
standardHigher
protected @Nullable E standardHigher(E e)
A sensible definition ofhigher(E)
in terms of theiterator
method oftailSet(Object, boolean)
. If you overridetailSet(Object, boolean)
, you may wish to overridehigher(E)
to forward to this implementation.
-
pollFirst
public @Nullable E pollFirst()
- Specified by:
pollFirst
in interfaceNavigableSet<E extends @Nullable Object>
-
standardPollFirst
protected @Nullable E standardPollFirst()
A sensible definition ofpollFirst()
in terms of theiterator
method. If you overrideForwardingCollection.iterator()
you may wish to overridepollFirst()
to forward to this implementation.
-
pollLast
public @Nullable E pollLast()
- Specified by:
pollLast
in interfaceNavigableSet<E extends @Nullable Object>
-
standardPollLast
protected @Nullable E standardPollLast()
A sensible definition ofpollLast()
in terms of thedescendingIterator
method. If you overridedescendingIterator()
you may wish to overridepollLast()
to forward to this implementation.
-
standardFirst
protected E standardFirst()
-
standardLast
protected E standardLast()
-
descendingSet
public NavigableSet<E> descendingSet()
- Specified by:
descendingSet
in interfaceNavigableSet<E extends @Nullable Object>
-
descendingIterator
public Iterator<E> descendingIterator()
- Specified by:
descendingIterator
in interfaceNavigableSet<E extends @Nullable Object>
-
subSet
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
- Specified by:
subSet
in interfaceNavigableSet<E extends @Nullable Object>
-
standardSubSet
protected NavigableSet<E> standardSubSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
A sensible definition ofsubSet(Object, boolean, Object, boolean)
in terms of theheadSet
andtailSet
methods. In many cases, you may wish to overridesubSet(Object, boolean, Object, boolean)
to forward to this implementation.
-
standardSubSet
protected SortedSet<E> standardSubSet(E fromElement, E toElement)
A sensible definition ofForwardingSortedSet.subSet(Object, Object)
in terms of thesubSet(Object, boolean, Object, boolean)
method. If you overridesubSet(Object, boolean, Object, boolean)
, you may wish to overrideForwardingSortedSet.subSet(Object, Object)
to forward to this implementation.- Overrides:
standardSubSet
in classForwardingSortedSet<E extends @Nullable Object>
-
headSet
public NavigableSet<E> headSet(E toElement, boolean inclusive)
- Specified by:
headSet
in interfaceNavigableSet<E extends @Nullable Object>
-
standardHeadSet
protected SortedSet<E> standardHeadSet(E toElement)
A sensible definition ofForwardingSortedSet.headSet(Object)
in terms of theheadSet(Object, boolean)
method. If you overrideheadSet(Object, boolean)
, you may wish to overrideForwardingSortedSet.headSet(Object)
to forward to this implementation.
-
tailSet
public NavigableSet<E> tailSet(E fromElement, boolean inclusive)
- Specified by:
tailSet
in interfaceNavigableSet<E extends @Nullable Object>
-
standardTailSet
protected SortedSet<E> standardTailSet(E fromElement)
A sensible definition ofForwardingSortedSet.tailSet(Object)
in terms of thetailSet(Object, boolean)
method. If you overridetailSet(Object, boolean)
, you may wish to overrideForwardingSortedSet.tailSet(Object)
to forward to this implementation.
-
-