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>

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`

Nested Class Summary

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

Constructor Summary
`ForwardingSortedMap()`

Method Summary
`Comparator<? super K>` | `comparator()` Returns the comparator used to order the keys in this map, or `null` if this map uses the natural ordering of its keys.
`protected abstract SortedMap<K,V>` | `delegate()` Returns the backing delegate instance that methods are forwarded to.
`K` | `firstKey()` Returns the first (lowest) key currently in this map.
`SortedMap<K,V>` | `headMap(K toKey)` Returns a view of the portion of this map whose keys are strictly less than `toKey`.
`K` | `lastKey()` Returns the last (highest) key currently in this map.
`SortedMap<K,V>` | `subMap(K fromKey, K toKey)` Returns a view of the portion of this map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
`SortedMap<K,V>` | `tailMap(K fromKey)` Returns a view of the portion of this map whose keys are greater than or equal to `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

    public ForwardingSortedMap()

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()

  Description copied from interface: `java.util.SortedMap`
  Returns the comparator used to order the keys in this map, or `null` if this map uses the natural ordering of its keys.

  Specified by:
    `comparator` in interface `SortedMap<K,V>`
  Returns:
    the comparator used to order the keys in this map, or `null` if this map uses the natural ordering of its keys

### firstKey

    public K firstKey()

  Description copied from interface: `java.util.SortedMap`
  Returns the first (lowest) key currently in this map.

  Specified by:
    `firstKey` in interface `SortedMap<K,V>`
  Returns:
    the first (lowest) key currently in this map

### headMap

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

  Description copied from interface: `java.util.SortedMap`
  Returns a view of the portion of this map whose keys are strictly less than `toKey`. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

  The returned map will throw an `IllegalArgumentException` on an attempt to insert a key outside its range.

  Specified by:
    `headMap` in interface `SortedMap<K,V>`
  Parameters:
    `toKey` - high endpoint (exclusive) of the keys in the returned map
  Returns:
    a view of the portion of this map whose keys are strictly less than `toKey`

### lastKey

    public K lastKey()

  Description copied from interface: `java.util.SortedMap`
  Returns the last (highest) key currently in this map.

  Specified by:
    `lastKey` in interface `SortedMap<K,V>`
  Returns:
    the last (highest) key currently in this map

### subMap

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

  Description copied from interface: `java.util.SortedMap`
  Returns a view of the portion of this map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive. (If `fromKey` and `toKey` are equal, the returned map is empty.) The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

  The returned map will throw an `IllegalArgumentException` on an attempt to insert a key outside its range.

  Specified by:
    `subMap` in interface `SortedMap<K,V>`
  Parameters:
    `fromKey` - low endpoint (inclusive) of the keys in the returned map
    `toKey` - high endpoint (exclusive) of the keys in the returned map
  Returns:
    a view of the portion of this map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive

### tailMap

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

  Description copied from interface: `java.util.SortedMap`
  Returns a view of the portion of this map whose keys are greater than or equal to `fromKey`. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

  The returned map will throw an `IllegalArgumentException` on an attempt to insert a key outside its range.

  Specified by:
    `tailMap` in interface `SortedMap<K,V>`
  Parameters:
    `fromKey` - low endpoint (inclusive) of the keys in the returned map
  Returns:
    a view of the portion of this map whose keys are greater than or equal to `fromKey`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD