org.elasticsearch.util.collect
Class ForwardingSortedMap<K,V>

java.lang.Object
  extended by org.elasticsearch.util.collect.ForwardingObject
      extended by org.elasticsearch.util.collect.ForwardingMap<K,V>
          extended by org.elasticsearch.util.collect.ForwardingSortedMap<K,V>
All Implemented Interfaces:
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.

See Also:
ForwardingObject

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Constructor Summary
ForwardingSortedMap()
           
 
Method Summary
 java.util.Comparator<? super K> comparator()
           
protected abstract  java.util.SortedMap<K,V> delegate()
          Returns the backing delegate instance that methods are forwarded to.
 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 org.elasticsearch.util.collect.ForwardingMap
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class org.elasticsearch.util.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

public ForwardingSortedMap()
Method Detail

delegate

protected abstract java.util.SortedMap<K,V> delegate()
Description copied from class: ForwardingObject
Returns 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 as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:
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>