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 SummaryConstructors Modifier Constructor Description protectedForwardingSortedSet()Constructor for use by subclasses.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Comparator<? super E>comparator()Returns the comparator used to order the elements in this set, ornullif this set uses the natural ordering of its elements.protected abstract SortedSet<E>delegate()Returns the backing delegate instance that methods are forwarded to.Efirst()Returns the first (lowest) element currently in this set.SortedSet<E>headSet(E toElement)Returns a view of the portion of this set whose elements are strictly less thantoElement.Elast()Returns the last (highest) element currently in this set.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)Returns a view of the portion of this set whose elements range fromfromElement, inclusive, totoElement, exclusive.SortedSet<E>tailSet(E fromElement)Returns a view of the portion of this set whose elements are greater than or equal tofromElement.- 
Methods inherited from class com.google.common.collect.ForwardingSetequals, hashCode, standardEquals, standardHashCode, standardRemoveAll
 - 
Methods inherited from class com.google.common.collect.ForwardingCollectionadd, 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.ForwardingObjecttoString
 - 
Methods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface java.util.CollectionparallelStream, removeIf, stream, toArray
 - 
Methods inherited from interface java.util.Setadd, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 - 
Methods inherited from interface java.util.SortedSetspliterator
 
- 
 
- 
- 
- 
Constructor Detail- 
ForwardingSortedSetprotected ForwardingSortedSet() Constructor for use by subclasses.
 
- 
 - 
Method Detail- 
delegateprotected 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 class- ForwardingSet<E extends @Nullable Object>
 
 - 
comparator@CheckForNull public Comparator<? super E> comparator() Description copied from interface:java.util.SortedSetReturns the comparator used to order the elements in this set, ornullif this set uses the natural ordering of its elements.- Specified by:
- comparatorin interface- SortedSet<E extends @Nullable Object>
- Returns:
- the comparator used to order the elements in this set,
         or nullif this set uses the natural ordering of its elements
 
 - 
firstpublic E first() Description copied from interface:java.util.SortedSetReturns the first (lowest) element currently in this set.
 - 
headSetpublic SortedSet<E> headSet(E toElement) Description copied from interface:java.util.SortedSetReturns a view of the portion of this set whose elements are strictly less thantoElement. 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 IllegalArgumentExceptionon an attempt to insert an element outside its range.
 - 
lastpublic E last() Description copied from interface:java.util.SortedSetReturns the last (highest) element currently in this set.
 - 
subSetpublic SortedSet<E> subSet(E fromElement, E toElement) Description copied from interface:java.util.SortedSetReturns a view of the portion of this set whose elements range fromfromElement, inclusive, totoElement, exclusive. (IffromElementandtoElementare 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 IllegalArgumentExceptionon an attempt to insert an element outside its range.- Specified by:
- subSetin interface- SortedSet<E extends @Nullable Object>
- 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, totoElement, exclusive
 
 - 
tailSetpublic SortedSet<E> tailSet(E fromElement) Description copied from interface:java.util.SortedSetReturns a view of the portion of this set whose elements are greater than or equal tofromElement. 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 IllegalArgumentExceptionon an attempt to insert an element outside its range.
 - 
standardContains@Beta 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 class- ForwardingCollection<E extends @Nullable Object>
- Since:
- 7.0
 
 - 
standardRemove@Beta 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 class- ForwardingCollection<E extends @Nullable Object>
- Since:
- 7.0
 
 - 
standardSubSet@Beta 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
 
 
- 
 
-