|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingCollection<E>
com.google.common.collect.ForwardingSet<E>
com.google.common.collect.ForwardingSortedSet<E>
@GwtCompatible public abstract class ForwardingSortedSet<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 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.
| Constructor Summary | |
|---|---|
protected |
ForwardingSortedSet()
Constructor for use by subclasses. |
| Method Summary | |
|---|---|
Comparator<? super E> |
comparator()
|
protected abstract SortedSet<E> |
delegate()
Returns the backing delegate instance that methods are forwarded to. |
E |
first()
|
SortedSet<E> |
headSet(E toElement)
|
E |
last()
|
protected boolean |
standardContains(Object object)
A sensible definition of ForwardingCollection.contains(java.lang.Object) in terms of the first()
method of tailSet(E). |
protected boolean |
standardRemove(Object object)
A sensible definition of ForwardingCollection.remove(java.lang.Object) in terms of the iterator()
method of tailSet(E). |
protected SortedSet<E> |
standardSubSet(E fromElement,
E toElement)
A sensible default implementation of subSet(Object, Object) in
terms of headSet(Object) and tailSet(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 |
| Methods inherited from class com.google.common.collect.ForwardingCollection |
|---|
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContainsAll, standardIsEmpty, standardRemoveAll, 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.Set |
|---|
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray |
| Constructor Detail |
|---|
protected ForwardingSortedSet()
| Method Detail |
|---|
protected abstract SortedSet<E> delegate()
ForwardingObjectForwardingSet.delegate(). Concrete subclasses override this method to supply
the instance being decorated.
delegate in class ForwardingSet<E>public Comparator<? super E> comparator()
comparator in interface SortedSet<E>public E first()
first in interface SortedSet<E>public SortedSet<E> headSet(E toElement)
headSet in interface SortedSet<E>public E last()
last in interface SortedSet<E>
public SortedSet<E> subSet(E fromElement,
E toElement)
subSet in interface SortedSet<E>public SortedSet<E> tailSet(E fromElement)
tailSet in interface SortedSet<E>
@Beta
protected boolean standardContains(@Nullable
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
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 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.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||