AbstractSortedMapDecorator (Commons Collections 4.0-alpha1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.collections4.map
Class AbstractSortedMapDecorator<K,V>

java.lang.Object
  org.apache.commons.collections4.map.AbstractIterableMap<K,V>
      org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
          org.apache.commons.collections4.map.AbstractSortedMapDecorator<K,V>


Type Parameters:: K - the type of the keys in the map; V - the type of the values in the map

All Implemented Interfaces:: Map<K,V>, SortedMap<K,V>, Get<K,V>, IterableGet<K,V>, IterableMap<K,V>, IterableSortedMap<K,V>, OrderedMap<K,V>, Put<K,V>

Direct Known Subclasses:: DualTreeBidiMap.ViewMap, FixedSizeSortedMap, UnmodifiableSortedMap

public abstract class AbstractSortedMapDecorator<K,V>
extends AbstractMapDecorator<K,V>
implements IterableSortedMap<K,V>
extends AbstractMapDecorator<K,V>
implements IterableSortedMap<K,V>

Provides a base decorator that enables additional functionality to be added to a Map via decoration.

Methods are forwarded directly to the decorated map.

This implementation does not perform any special processing with the map views. Instead it simply returns the set/collection from the wrapped map. This may be undesirable, for example if you are trying to write a validating implementation it would provide a loophole around the validation. But, you might want that loophole, so this class is kept simple.

Since:: 3.0
Version:: $Id: AbstractSortedMapDecorator.java 1477799 2013-04-30 19:56:11Z tn $

Nested Class Summary
`protected static class`	`AbstractSortedMapDecorator.SortedMapIterator<K,V>` OrderedMapIterator implementation.

Constructor Summary
`protected`	`AbstractSortedMapDecorator()` Constructor only used in deserialization, do not use otherwise.
	`AbstractSortedMapDecorator(SortedMap<K,V> map)` Constructor that wraps (not copies).

Method Summary
`Comparator<? super K>`	`comparator()`
`protected SortedMap<K,V>`	`decorated()` Gets the map being decorated.
`K`	`firstKey()` Gets the first key currently in this map.
`SortedMap<K,V>`	`headMap(K toKey)`
`K`	`lastKey()` Gets the last key currently in this map.
`OrderedMapIterator<K,V>`	`mapIterator()` Obtains a `MapIterator` over the map. A map iterator is an efficient way of iterating over maps. There is no need to access the entry set or use Map Entry objects. IterableMap map = new HashedMap(); MapIterator it = map.mapIterator(); while (it.hasNext()) { String key = it.next(); Integer value = it.getValue(); it.setValue(value + 1); }
`K`	`nextKey(K key)` Gets the next key after the one specified.
`K`	`previousKey(K key)` Gets the previous key before the one specified.
`SortedMap<K,V>`	`subMap(K fromKey, K toKey)`
`SortedMap<K,V>`	`tailMap(K fromKey)`

Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
`clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.apache.commons.collections4.Put
`clear, put, putAll`

Methods inherited from interface org.apache.commons.collections4.Get
`containsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size, values`

Constructor Detail