@GwtCompatible public abstract class ForwardingSortedSet<E> extends ForwardingSet<E> implements java.util.SortedSet<E>
Warning: The methods of ForwardingSortedSet
forward
indiscriminately to the methods of the delegate. For example,
overriding ForwardingCollection.add(E)
alone will not change the behavior of ForwardingCollection.addAll(java.util.Collection<? extends E>)
, which can lead to unexpected behavior. In this case, you should
override addAll
as well, either providing your own implementation, or
delegating to the provided standardAddAll
method.
Each of the standard
methods, 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 the
Set
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.
Modifier | Constructor and Description |
---|---|
protected |
ForwardingSortedSet()
Constructor for use by subclasses.
|
Modifier and Type | Method and Description |
---|---|
java.util.Comparator<? super E> |
comparator() |
protected abstract java.util.SortedSet<E> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
E |
first() |
java.util.SortedSet<E> |
headSet(E toElement) |
E |
last() |
protected boolean |
standardContains(java.lang.Object object)
A sensible definition of
ForwardingCollection.contains(java.lang.Object) in terms of the first()
method of tailSet(E) . |
protected boolean |
standardRemove(java.lang.Object object)
A sensible definition of
ForwardingCollection.remove(java.lang.Object) in terms of the iterator()
method of tailSet(E) . |
protected java.util.SortedSet<E> |
standardSubSet(E fromElement,
E toElement)
A sensible default implementation of
subSet(Object, Object) in
terms of headSet(Object) and tailSet(Object) . |
java.util.SortedSet<E> |
subSet(E fromElement,
E toElement) |
java.util.SortedSet<E> |
tailSet(E fromElement) |
equals, hashCode, standardEquals, standardHashCode
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContainsAll, standardIsEmpty, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray
toString
protected ForwardingSortedSet()
protected abstract java.util.SortedSet<E> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply
the instance being decorated.delegate
in class ForwardingSet<E>
public java.util.Comparator<? super E> comparator()
comparator
in interface java.util.SortedSet<E>
public java.util.SortedSet<E> headSet(E toElement)
headSet
in interface java.util.SortedSet<E>
public java.util.SortedSet<E> subSet(E fromElement, E toElement)
subSet
in interface java.util.SortedSet<E>
public java.util.SortedSet<E> tailSet(E fromElement)
tailSet
in interface java.util.SortedSet<E>
@Beta protected boolean standardContains(@Nullable java.lang.Object object)
ForwardingCollection.contains(java.lang.Object)
in terms of the first()
method of tailSet(E)
. If you override tailSet(E)
, you may wish
to override ForwardingCollection.contains(java.lang.Object)
to forward to this implementation.standardContains
in class ForwardingCollection<E>
@Beta protected boolean standardRemove(@Nullable java.lang.Object object)
ForwardingCollection.remove(java.lang.Object)
in terms of the iterator()
method of tailSet(E)
. If you override tailSet(E)
, you may wish
to override ForwardingCollection.remove(java.lang.Object)
to forward to this implementation.standardRemove
in class ForwardingCollection<E>
@Beta protected java.util.SortedSet<E> standardSubSet(E fromElement, E toElement)
subSet(Object, Object)
in
terms of headSet(Object)
and tailSet(Object)
. In some
situations, you may wish to override subSet(Object, Object)
to
forward to this implementation.