Package org.sosy_lab.common.collect

Interface PersistentSortedMap<K,V extends @Nullable Object>

Type Parameters:

K - The type of keys.

V - The type of values.

All Superinterfaces:

Map<K,V>, NavigableMap<K,V>, PersistentMap<K,V>, SortedMap<K,V>

All Known Implementing Classes:

PathCopyingPersistentTreeMap

@Immutable(containerOf={"K","V"})
public interface PersistentSortedMap<K,V extends @Nullable Object>
extends NavigableMap<K,V>

Sub-interface of PersistentMap analog to NavigableMap.

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
NavigableMap<K,V>	descendingMap()
PersistentSortedMap<K,V>	empty()	Replacement for {PersistentMap.clear() that returns an empty instance.
NavigableSet<Map.Entry<K,V>>	entrySet()
NavigableMap<K,V>	headMap(K pToKey)
NavigableMap<K,V>	headMap(K pToKey, boolean pInclusive)
NavigableSet<K>	keySet()
Map.Entry<K,V>	pollFirstEntry()	Deprecated. Unsupported operation.
Map.Entry<K,V>	pollLastEntry()	Deprecated. Unsupported operation.
PersistentSortedMap<K,V>	putAndCopy(K key, V value)	Replacement for {PersistentMap.put(Object, Object) that returns a fresh instance.
PersistentSortedMap<K,V>	removeAndCopy(Object pKey)	Replacement for {PersistentMap.remove(Object) that returns a fresh instance.
NavigableMap<K,V>	subMap(K pFromKey, boolean pFromInclusive, K pToKey, boolean pToInclusive)
NavigableMap<K,V>	subMap(K pFromKey, K pToKey)
NavigableMap<K,V>	tailMap(K pFromKey)
NavigableMap<K,V>	tailMap(K pFromKey, boolean pInclusive)

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, size

Methods inherited from interface java.util.NavigableMap

ceilingEntry, ceilingKey, descendingKeySet, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, navigableKeySet

Methods inherited from interface org.sosy_lab.common.collect.PersistentMap

clear, compute, computeIfAbsent, computeIfPresent, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Methods inherited from interface java.util.SortedMap

comparator, firstKey, lastKey, values

Method Detail

putAndCopy

@CheckReturnValue
PersistentSortedMap<K,V> putAndCopy(K key,
                                          V value)

Description copied from interface: PersistentMap

Replacement for {PersistentMap.put(Object, Object) that returns a fresh instance.

Specified by:

putAndCopy in interface PersistentMap<K,V extends @Nullable Object>

removeAndCopy

@CheckReturnValue
PersistentSortedMap<K,V> removeAndCopy(Object pKey)

Description copied from interface: PersistentMap

Replacement for {PersistentMap.remove(Object) that returns a fresh instance.

Specified by:

removeAndCopy in interface PersistentMap<K,V extends @Nullable Object>

empty

@CheckReturnValue
PersistentSortedMap<K,V> empty()

Description copied from interface: PersistentMap

Replacement for {PersistentMap.clear() that returns an empty instance.

Specified by:

empty in interface PersistentMap<K,V extends @Nullable Object>

entrySet

NavigableSet<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V extends @Nullable Object>

Specified by:

entrySet in interface SortedMap<K,V extends @Nullable Object>

keySet

NavigableSet<K> keySet()

Specified by:

keySet in interface Map<K,V extends @Nullable Object>

Specified by:

keySet in interface SortedMap<K,V extends @Nullable Object>

descendingMap

NavigableMap<K,V> descendingMap()

Specified by:

descendingMap in interface NavigableMap<K,V extends @Nullable Object>

subMap

NavigableMap<K,V> subMap(K pFromKey,
                               K pToKey)

Specified by:

subMap in interface NavigableMap<K,V extends @Nullable Object>

Specified by:

subMap in interface SortedMap<K,V extends @Nullable Object>

subMap

NavigableMap<K,V> subMap(K pFromKey,
                               boolean pFromInclusive,
                               K pToKey,
                               boolean pToInclusive)

Specified by:

subMap in interface NavigableMap<K,V extends @Nullable Object>

headMap

NavigableMap<K,V> headMap(K pToKey)

Specified by:

headMap in interface NavigableMap<K,V extends @Nullable Object>

Specified by:

headMap in interface SortedMap<K,V extends @Nullable Object>

headMap

NavigableMap<K,V> headMap(K pToKey,
                                boolean pInclusive)

Specified by:

headMap in interface NavigableMap<K,V extends @Nullable Object>

tailMap

NavigableMap<K,V> tailMap(K pFromKey)

Specified by:

tailMap in interface NavigableMap<K,V extends @Nullable Object>

Specified by:

tailMap in interface SortedMap<K,V extends @Nullable Object>

tailMap

NavigableMap<K,V> tailMap(K pFromKey,
                                boolean pInclusive)

Specified by:

tailMap in interface NavigableMap<K,V extends @Nullable Object>

pollFirstEntry

@Deprecated
Map.Entry<K,V> pollFirstEntry()

Deprecated.

Unsupported operation.

Specified by:

pollFirstEntry in interface NavigableMap<K,V extends @Nullable Object>

Throws:

UnsupportedOperationException - Always.

pollLastEntry

@Deprecated
Map.Entry<K,V> pollLastEntry()

Deprecated.

Unsupported operation.

Specified by:

pollLastEntry in interface NavigableMap<K,V extends @Nullable Object>

Throws:

UnsupportedOperationException - Always.