com.google.common.collect
Class ForwardingSortedSet<E>

java.lang.Object
  extended by com.google.common.collect.ForwardingObject
      extended by com.google.common.collect.ForwardingCollection<E>
          extended by com.google.common.collect.ForwardingSet<E>
              extended by com.google.common.collect.ForwardingSortedSet<E>
All Implemented Interfaces:
Serializable, Iterable<E>, Collection<E>, Set<E>, SortedSet<E>

public abstract class ForwardingSortedSet<E>
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.

Author:
Mike Bostock
See Also:
ForwardingObject, Serialized Form

Constructor Summary
protected ForwardingSortedSet(SortedSet<E> delegate)
          Constructs a forwarding sorted set that forwards to the provided delegate.
 
Method Summary
 Comparator<? super E> comparator()
           
protected  SortedSet<E> delegate()
          Returns the backing delegate object.
 E first()
           
 SortedSet<E> headSet(E toElement)
           
 E last()
           
 SortedSet<E> subSet(E fromElement, E toElement)
           
 SortedSet<E> tailSet(E fromElement)
           
 
Methods inherited from class com.google.common.collect.ForwardingSet
equals, hashCode
 
Methods inherited from class com.google.common.collect.ForwardingCollection
add, addAll, clear, contains, containsAll, containsAllImpl, containsImpl, isEmpty, iterator, remove, removeAll, removeAllImpl, removeImpl, retainAll, retainAllImpl, size, toArray, toArray, toArrayImpl, toArrayImpl, toStringImpl
 
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

ForwardingSortedSet

protected ForwardingSortedSet(SortedSet<E> delegate)
Constructs a forwarding sorted set that forwards to the provided delegate.

Method Detail

delegate

protected SortedSet<E> delegate()
Description copied from class: ForwardingObject
Returns the backing delegate object. This method should be overridden to specify the correct return type. For example:
  @SuppressWarnings("unchecked")
  @Override protected Foo delegate() {
    return (Foo) super.delegate();
  }
This method should always return the same delegate instance that was passed to the constructor.

Overrides:
delegate in class ForwardingSet<E>

comparator

public Comparator<? super E> comparator()
Specified by:
comparator in interface SortedSet<E>

first

public E first()
Specified by:
first in interface SortedSet<E>

headSet

public SortedSet<E> headSet(E toElement)
Specified by:
headSet in interface SortedSet<E>

last

public E last()
Specified by:
last in interface SortedSet<E>

subSet

public SortedSet<E> subSet(E fromElement,
                           E toElement)
Specified by:
subSet in interface SortedSet<E>

tailSet

public SortedSet<E> tailSet(E fromElement)
Specified by:
tailSet in interface SortedSet<E>