ForwardingSortedMap (Guava: Google Core Libraries for Java

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: Map<K,V>, SortedMap<K,V>

public abstract class ForwardingSortedMap<K,V>
extends ForwardingMap<K,V>
implements SortedMap<K,V>
extends ForwardingMap<K,V>
implements 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.

Since:: 2 (imported from Google Collections Library)
Author:: Mike Bostock
See Also:: ForwardingObject

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map
`Map.Entry<K,V>`

Constructor Summary
`protected`	`ForwardingSortedMap()` Constructor for use by subclasses.

Method Summary
`Comparator<? super K>`	`comparator()`
`protected abstract SortedMap<K,V>`	`delegate()` Returns the backing delegate instance that methods are forwarded to.
`K`	`firstKey()`
`SortedMap<K,V>`	`headMap(K toKey)`
`K`	`lastKey()`
`SortedMap<K,V>`	`subMap(K fromKey, K toKey)`
`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()

Constructor for use by subclasses.

Method Detail

delegate

protected abstract 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 Comparator<? super K> comparator()

Specified by:: comparator in interface SortedMap<K,V>

firstKey

public K firstKey()

Specified by:: firstKey in interface SortedMap<K,V>

headMap

public SortedMap<K,V> headMap(K toKey)

Specified by:: headMap in interface SortedMap<K,V>

lastKey

public K lastKey()

Specified by:: lastKey in interface SortedMap<K,V>

subMap

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

Specified by:: subMap in interface SortedMap<K,V>

tailMap

public SortedMap<K,V> tailMap(K fromKey)

Specified by:: tailMap in interface SortedMap<K,V>