com.google.common.collect
Class ForwardingSortedMap<K,V>

java.lang.Object
  com.google.common.collect.ForwardingObject
      com.google.common.collect.ForwardingMap<K,V>
          com.google.common.collect.ForwardingSortedMap<K,V>

All Implemented Interfaces:

java.io.Serializable, java.util.Map<K,V>, java.util.SortedMap<K,V>

public abstract class ForwardingSortedMap<K,V>
extends ForwardingMap<K,V>
implements java.util.SortedMap<K,V>

A sorted map which forwards all its method calls to another sorted map. Subclasses should override one or more methods to modify the behavior of the backing sorted map as desired per the decorator pattern.

Author:

Mike Bostock

See Also:

ForwardingObject, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

protected

ForwardingSortedMap(java.util.SortedMap<K,V> delegate) Constructs a forwarding sorted map that forwards to the provided delegate.

Method Summary

java.util.Comparator<? super K>	comparator()
protected java.util.SortedMap<K,V>	delegate() Returns the backing delegate object.
K	firstKey()
java.util.SortedMap<K,V>	headMap(K toKey)
K	lastKey()
java.util.SortedMap<K,V>	subMap(K fromKey, K toKey)
java.util.SortedMap<K,V>	tailMap(K fromKey)

Methods inherited from class com.google.common.collect.ForwardingMap

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

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.SortedMap

entrySet, keySet, values

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size

Constructor Detail

ForwardingSortedMap

protected ForwardingSortedMap(java.util.SortedMap<K,V> delegate)

Constructs a forwarding sorted map that forwards to the provided delegate.

Method Detail

delegate

protected java.util.SortedMap<K,V> 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 ForwardingMap<K,V>

comparator

public java.util.Comparator<? super K> comparator()

Specified by:

comparator in interface java.util.SortedMap<K,V>

firstKey

public K firstKey()

Specified by:

firstKey in interface java.util.SortedMap<K,V>

headMap

public java.util.SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface java.util.SortedMap<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface java.util.SortedMap<K,V>

subMap

public java.util.SortedMap<K,V> subMap(K fromKey,
                                       K toKey)

Specified by:

subMap in interface java.util.SortedMap<K,V>

tailMap

public java.util.SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface java.util.SortedMap<K,V>