Package com.tangosol.util

Class SafeSortedMap

java.lang.Object

java.util.AbstractMap

java.util.concurrent.ConcurrentSkipListMap

com.tangosol.util.SafeSortedMap

All Implemented Interfaces:

Serializable, Cloneable, ConcurrentMap, ConcurrentNavigableMap, Map, NavigableMap, SequencedMap, SortedMap

public class SafeSortedMap
extends ConcurrentSkipListMap

Implementation of a SortedMap extending ConcurrentSkipListMap to support null keys and null values. Note that unlike its super class, this class is not serializable.

Since:

23.03

Author:

mg

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SafeSortedMap.EntrySet	Entry set delegation of the super map implementation.
protected static class	SafeSortedMap.KeySet	Key set delegation of the super map implementation.
static class	SafeSortedMap.Null
protected static class	SafeSortedMap.NullableEntry	Map.Entry implementation that supports null key/value placeholders.
protected static class	SafeSortedMap.SubMap	SubMap delegation to manage NULL in entry key and/or value.
protected static class	SafeSortedMap.Values	Values delegation of the super map implementation.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
static final SortedMap<?,?>	EMPTY	An empty, immutable SafeSortedMap instance.
static final Object	NULL	Placeholder for a null key or value.

Constructor Summary

Constructors

Constructor	Description
SafeSortedMap()	Construct a new SafeSortedMap using the natural ordering of the Comparable keys in this map.
SafeSortedMap(Comparator comparator)	Construct a new SafeSortedMap with the specified Comparator.
SafeSortedMap(SortedMap that)	Construct a new SafeSortedMap copying the contents of the specified map.

Method Summary

Modifier and Type	Method	Description
SafeSortedMap	clone()
Object	compute(Object oKey, BiFunction remappingFunction)
Object	computeIfAbsent(Object oKey, Function mappingFunction)
Object	computeIfPresent(Object oKey, BiFunction remappingFunction)
boolean	containsKey(Object oKey)
boolean	containsValue(Object oValue)
NavigableSet	descendingKeySet()
ConcurrentNavigableMap	descendingMap()
Set<Map.Entry>	entrySet()
boolean	equals(Object oMap)
Object	firstKey()
void	forEach(BiConsumer action)
Object	get(Object oKey)
Map.Entry	getEntry(Object oKey)	Locate a Map.Entry in this map based on its key.
Object	getOrDefault(Object oKey, Object oDefaultValue)
ConcurrentNavigableMap	headMap(Object oToKey)
ConcurrentNavigableMap	headMap(Object oToKey, boolean fInclusive)
NavigableSet	keySet()
Object	lastKey()
Object	merge(Object oKey, Object oValue, BiFunction remappingFunction)
Object	put(Object oKey, Object oValue)
Object	putIfAbsent(Object oKey, Object oValue)
Object	remove(Object oKey)
boolean	remove(Object oKey, Object oValue)
Object	replace(Object oKey, Object oValue)
boolean	replace(Object oKey, Object oOldValue, Object oNewValue)
void	replaceAll(BiFunction function)
ConcurrentNavigableMap	subMap(Object oFromKey, boolean fFromInclusive, Object oToKey, boolean fToInclusive)
ConcurrentNavigableMap	subMap(Object oFromKey, Object oToKey)
ConcurrentNavigableMap	tailMap(Object fromKey)
ConcurrentNavigableMap	tailMap(Object oFromKey, boolean fInclusive)
Collection	values()

Methods inherited from class java.util.concurrent.ConcurrentSkipListMap

ceilingEntry, ceilingKey, clear, comparator, firstEntry, floorEntry, floorKey, higherEntry, higherKey, isEmpty, lastEntry, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, putFirst, putLast, size

Methods inherited from class java.util.AbstractMap

hashCode, putAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

hashCode, putAll

Methods inherited from interface java.util.NavigableMap

reversed

Methods inherited from interface java.util.SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Field Details

EMPTY

public static final SortedMap<?,?> EMPTY

An empty, immutable SafeSortedMap instance.

NULL

public static final Object NULL

Placeholder for a null key or value.

Constructor Details

SafeSortedMap

public SafeSortedMap()

Construct a new SafeSortedMap using the natural ordering of the Comparable keys in this map.

SafeSortedMap

public SafeSortedMap(SortedMap that)

Construct a new SafeSortedMap copying the contents of the specified map.

Parameters:

that - the map copied

SafeSortedMap

public SafeSortedMap(Comparator comparator)

Construct a new SafeSortedMap with the specified Comparator.

Parameters:

comparator - the comparator used to sort this map

Method Details

get

public Object get(Object oKey)

Specified by:

get in interface Map

Overrides:

get in class ConcurrentSkipListMap

put

public Object put(Object oKey,
 Object oValue)

Specified by:

put in interface Map

Overrides:

put in class ConcurrentSkipListMap

remove

public Object remove(Object oKey)

Specified by:

remove in interface Map

Overrides:

remove in class ConcurrentSkipListMap

equals

public boolean equals(Object oMap)

Specified by:

equals in interface Map

Overrides:

equals in class ConcurrentSkipListMap

clone

public SafeSortedMap clone()

Overrides:

clone in class ConcurrentSkipListMap

containsKey

public boolean containsKey(Object oKey)

Specified by:

containsKey in interface Map

Overrides:

containsKey in class ConcurrentSkipListMap

containsValue

public boolean containsValue(Object oValue)

Specified by:

containsValue in interface Map

Overrides:

containsValue in class ConcurrentSkipListMap

entrySet

public Set<Map.Entry> entrySet()

Specified by:

entrySet in interface Map

Specified by:

entrySet in interface SortedMap

Overrides:

entrySet in class ConcurrentSkipListMap

keySet

public NavigableSet keySet()

Specified by:

keySet in interface ConcurrentNavigableMap

Specified by:

keySet in interface Map

Specified by:

keySet in interface SortedMap

Overrides:

keySet in class ConcurrentSkipListMap

values

public Collection values()

Specified by:

values in interface Map

Specified by:

values in interface SortedMap

Overrides:

values in class ConcurrentSkipListMap

descendingMap

public ConcurrentNavigableMap descendingMap()

Specified by:

descendingMap in interface ConcurrentNavigableMap

Specified by:

descendingMap in interface NavigableMap

Overrides:

descendingMap in class ConcurrentSkipListMap

descendingKeySet

public NavigableSet descendingKeySet()

Specified by:

descendingKeySet in interface ConcurrentNavigableMap

Specified by:

descendingKeySet in interface NavigableMap

Overrides:

descendingKeySet in class ConcurrentSkipListMap

getEntry

public Map.Entry getEntry(Object oKey)

Locate a Map.Entry in this map based on its key.

Note: the behaviour of {#setValue} on the returned Entry is undefined in the presence of concurrent modifications

Parameters:

oKey - the key to return an Entry for

Returns:

an Entry corresponding to the specified key, or null if none exists

firstKey

public Object firstKey()

Specified by:

firstKey in interface SortedMap

Overrides:

firstKey in class ConcurrentSkipListMap

lastKey

public Object lastKey()

Specified by:

lastKey in interface SortedMap

Overrides:

lastKey in class ConcurrentSkipListMap

subMap

public ConcurrentNavigableMap subMap(Object oFromKey,
 boolean fFromInclusive,
 Object oToKey,
 boolean fToInclusive)

Specified by:

subMap in interface ConcurrentNavigableMap

Specified by:

subMap in interface NavigableMap

Overrides:

subMap in class ConcurrentSkipListMap

headMap

public ConcurrentNavigableMap headMap(Object oToKey,
 boolean fInclusive)

Specified by:

headMap in interface ConcurrentNavigableMap

Specified by:

headMap in interface NavigableMap

Overrides:

headMap in class ConcurrentSkipListMap

tailMap

public ConcurrentNavigableMap tailMap(Object oFromKey,
 boolean fInclusive)

Specified by:

tailMap in interface ConcurrentNavigableMap

Specified by:

tailMap in interface NavigableMap

Overrides:

tailMap in class ConcurrentSkipListMap

subMap

public ConcurrentNavigableMap subMap(Object oFromKey,
 Object oToKey)

Specified by:

subMap in interface ConcurrentNavigableMap

Specified by:

subMap in interface NavigableMap

Specified by:

subMap in interface SortedMap

Overrides:

subMap in class ConcurrentSkipListMap

headMap

public ConcurrentNavigableMap headMap(Object oToKey)

Specified by:

headMap in interface ConcurrentNavigableMap

Specified by:

headMap in interface NavigableMap

Specified by:

headMap in interface SortedMap

Overrides:

headMap in class ConcurrentSkipListMap

tailMap

public ConcurrentNavigableMap tailMap(Object fromKey)

Specified by:

tailMap in interface ConcurrentNavigableMap

Specified by:

tailMap in interface NavigableMap

Specified by:

tailMap in interface SortedMap

Overrides:

tailMap in class ConcurrentSkipListMap

putIfAbsent

public Object putIfAbsent(Object oKey,
 Object oValue)

Specified by:

putIfAbsent in interface ConcurrentMap

Specified by:

putIfAbsent in interface Map

Overrides:

putIfAbsent in class ConcurrentSkipListMap

getOrDefault

public Object getOrDefault(Object oKey,
 Object oDefaultValue)

Specified by:

getOrDefault in interface ConcurrentMap

Specified by:

getOrDefault in interface Map

Overrides:

getOrDefault in class ConcurrentSkipListMap

forEach

public void forEach(BiConsumer action)

Specified by:

forEach in interface ConcurrentMap

Specified by:

forEach in interface Map

Overrides:

forEach in class ConcurrentSkipListMap

remove

public boolean remove(Object oKey,
 Object oValue)

Specified by:

remove in interface ConcurrentMap

Specified by:

remove in interface Map

Overrides:

remove in class ConcurrentSkipListMap

replace

public boolean replace(Object oKey,
 Object oOldValue,
 Object oNewValue)

Specified by:

replace in interface ConcurrentMap

Specified by:

replace in interface Map

Overrides:

replace in class ConcurrentSkipListMap

replace

public Object replace(Object oKey,
 Object oValue)

Specified by:

replace in interface ConcurrentMap

Specified by:

replace in interface Map

Overrides:

replace in class ConcurrentSkipListMap

replaceAll

public void replaceAll(BiFunction function)

Specified by:

replaceAll in interface ConcurrentMap

Specified by:

replaceAll in interface Map

Overrides:

replaceAll in class ConcurrentSkipListMap

computeIfAbsent

public Object computeIfAbsent(Object oKey,
 Function mappingFunction)

Specified by:

computeIfAbsent in interface ConcurrentMap

Specified by:

computeIfAbsent in interface Map

Overrides:

computeIfAbsent in class ConcurrentSkipListMap

computeIfPresent

public Object computeIfPresent(Object oKey,
 BiFunction remappingFunction)

Specified by:

computeIfPresent in interface ConcurrentMap

Specified by:

computeIfPresent in interface Map

Overrides:

computeIfPresent in class ConcurrentSkipListMap

compute

public Object compute(Object oKey,
 BiFunction remappingFunction)

Specified by:

compute in interface ConcurrentMap

Specified by:

compute in interface Map

Overrides:

compute in class ConcurrentSkipListMap

merge

public Object merge(Object oKey,
 Object oValue,
 BiFunction remappingFunction)

Specified by:

merge in interface ConcurrentMap

Specified by:

merge in interface Map

Overrides:

merge in class ConcurrentSkipListMap