Package org.apache.commons.collections.map

Class AbstractSortedMapDecorator

java.lang.Object

org.apache.commons.collections.map.AbstractMapDecorator

org.apache.commons.collections.map.AbstractSortedMapDecorator

All Implemented Interfaces:

Map, SequencedMap, SortedMap

Direct Known Subclasses:

FixedSizeSortedMap, UnmodifiableSortedMap

@Deprecated(since="2021-04-30")
public abstract class AbstractSortedMapDecorator
extends AbstractMapDecorator
implements SortedMap

Deprecated.

Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.

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:

Commons Collections 3.0

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
AbstractSortedMapDecorator(SortedMap map)	Deprecated. Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method	Description
Comparator	comparator()	Deprecated.
Object	firstKey()	Deprecated.
SortedMap	headMap(Object toKey)	Deprecated.
Object	lastKey()	Deprecated.
SortedMap	subMap(Object fromKey, Object toKey)	Deprecated.
SortedMap	tailMap(Object fromKey)	Deprecated.

Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap

entrySet, keySet, putFirst, putLast, reversed, values

Constructor Details

AbstractSortedMapDecorator

public AbstractSortedMapDecorator(SortedMap map)

Deprecated.

Constructor that wraps (not copies).

Parameters:

map - the map to decorate, must not be null

Throws:

IllegalArgumentException - if the collection is null

Method Details

comparator

public Comparator comparator()

Deprecated.

Specified by:

comparator in interface SortedMap

firstKey

public Object firstKey()

Deprecated.

Specified by:

firstKey in interface SortedMap

headMap

public SortedMap headMap(Object toKey)

Deprecated.

Specified by:

headMap in interface SortedMap

lastKey

public Object lastKey()

Deprecated.

Specified by:

lastKey in interface SortedMap

subMap

public SortedMap subMap(Object fromKey,
 Object toKey)

Deprecated.

Specified by:

subMap in interface SortedMap

tailMap

public SortedMap tailMap(Object fromKey)

Deprecated.

Specified by:

tailMap in interface SortedMap