Class ForwardingSortedSet<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>
-
- All Implemented Interfaces:
Iterable<E>,Collection<E>,Set<E>,SortedSet<E>
- Direct Known Subclasses:
ForwardingNavigableSet
@GwtCompatible public abstract class ForwardingSortedSet<E extends @Nullable Object> extends ForwardingSet<E> implements SortedSet<E>
A sorted set which forwards all its method calls to another sorted set. Subclasses should override one or more methods to modify the behavior of the backing sorted set as desired per the decorator pattern.Warning: The methods of
ForwardingSortedSetforward 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 overrideaddAllas well, either providing your own implementation, or delegating to the providedstandardAddAllmethod.defaultmethod warning: This class does not forward calls todefaultmethods. Instead, it inherits their default implementations. When those implementations invoke methods, they invoke methods on theForwardingSortedSet.Each of the
standardmethods, where appropriate, 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 theSetcontract.The
standardmethods 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:
- 2.0
- Author:
- Mike Bostock, Louis Wasserman
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedForwardingSortedSet()Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Comparator<? super E>comparator()protected abstract SortedSet<E>delegate()Returns the backing delegate instance that methods are forwarded to.Efirst()SortedSet<E>headSet(E toElement)Elast()protected booleanstandardContains(Object object)A sensible definition ofForwardingCollection.contains(java.lang.Object)in terms of thefirst()method oftailSet(E).protected booleanstandardRemove(Object object)A sensible definition ofForwardingCollection.remove(java.lang.Object)in terms of theiterator()method oftailSet(E).protected SortedSet<E>standardSubSet(E fromElement, E toElement)A sensible default implementation ofsubSet(Object, Object)in terms ofheadSet(Object)andtailSet(Object).SortedSet<E>subSet(E fromElement, E toElement)SortedSet<E>tailSet(E fromElement)-
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.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
-
Methods inherited from interface java.util.SortedSet
spliterator
-
-
-
-
Constructor Detail
-
ForwardingSortedSet
protected ForwardingSortedSet()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract SortedSet<E> delegate()
Description copied from class:ForwardingObjectReturns 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:
delegatein classForwardingSet<E extends @Nullable Object>
-
comparator
@CheckForNull public Comparator<? super E> comparator()
- Specified by:
comparatorin interfaceSortedSet<E extends @Nullable Object>
-
standardContains
protected boolean standardContains(@CheckForNull Object object)
A sensible definition ofForwardingCollection.contains(java.lang.Object)in terms of thefirst()method oftailSet(E). If you overridetailSet(E), you may wish to overrideForwardingCollection.contains(java.lang.Object)to forward to this implementation.- Overrides:
standardContainsin classForwardingCollection<E extends @Nullable Object>- Since:
- 7.0
-
standardRemove
protected boolean standardRemove(@CheckForNull Object object)
A sensible definition ofForwardingCollection.remove(java.lang.Object)in terms of theiterator()method oftailSet(E). If you overridetailSet(E), you may wish to overrideForwardingCollection.remove(java.lang.Object)to forward to this implementation.- Overrides:
standardRemovein classForwardingCollection<E extends @Nullable Object>- Since:
- 7.0
-
standardSubSet
protected SortedSet<E> standardSubSet(E fromElement, E toElement)
A sensible default implementation ofsubSet(Object, Object)in terms ofheadSet(Object)andtailSet(Object). In some situations, you may wish to overridesubSet(Object, Object)to forward to this implementation.- Since:
- 7.0
-
-