org.opendaylight.yangtools.triemap

Class TrieMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

org.opendaylight.yangtools.triemap.TrieMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

Serializable, ConcurrentMap<K,V>, Map<K,V>

Direct Known Subclasses:

ImmutableTrieMap, MutableTrieMap

@Beta
public abstract class TrieMap<K,V>
extends AbstractMap<K,V>
implements ConcurrentMap<K,V>, Serializable

This is a port of Scala's TrieMap class from the Scala Collections library. This implementation does not support null keys nor null values.

Author:

Aleksandar Prokopec (original Scala implementation), Roman Levenstein (original Java 6 port), Robert Varga

See Also:

Serialized Form

Nested Class Summary

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>

Method Summary

Modifier and Type	Method and Description
abstract void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
static <K,V> MutableTrieMap<K,V>	create()
Set<Map.Entry<K,V>>	entrySet()
V	get(Object key)
abstract ImmutableTrieMap<K,V>	immutableSnapshot() Returns a read-only snapshot of this TrieMap.
Set<K>	keySet()
abstract TrieMap<K,V>	mutableSnapshot() Returns a snapshot of this TrieMap.
abstract V	put(K key, V value)
abstract V	putIfAbsent(K key, V value)
abstract V	remove(Object key)
abstract boolean	remove(Object key, Object value)
abstract V	replace(K key, V value)
abstract boolean	replace(K key, V oldValue, V newValue)
abstract int	size()

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, isEmpty, putAll, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll, values

Method Detail

create

public static <K,V> MutableTrieMap<K,V> create()

mutableSnapshot

public abstract TrieMap<K,V> mutableSnapshot()

Returns a snapshot of this TrieMap. This operation is lock-free and linearizable. Modification operations on this Map and the returned one are isolated from each other.

The snapshot is lazily updated - the first time some branch in the snapshot or this TrieMap are accessed, they are rewritten. This means that the work of rebuilding both the snapshot and this TrieMap is distributed across all the threads doing updates or accesses subsequent to the snapshot creation.

Returns:

A read-write TrieMap containing the contents of this map.

immutableSnapshot

public abstract ImmutableTrieMap<K,V> immutableSnapshot()

Returns a read-only snapshot of this TrieMap. This operation is lock-free and linearizable.

The snapshot is lazily updated - the first time some branch of this TrieMap are accessed, it is rewritten. The work of creating the snapshot is thus distributed across subsequent updates and accesses on this TrieMap by all threads. Note that the snapshot itself is never rewritten unlike when calling mutableSnapshot(), but the obtained snapshot cannot be modified.

This method is used by other methods such as `size` and `iterator`.

Returns:

A read-only TrieMap containing the contents of this map.

containsKey

public final boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractMap<K,V>

containsValue

public final boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class AbstractMap<K,V>

entrySet

public final Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in class AbstractMap<K,V>

keySet

public final Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractMap<K,V>

get

public final V get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get in class AbstractMap<K,V>

clear

public abstract void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

put

public abstract V put(K key,
                      V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMap<K,V>

putIfAbsent

public abstract V putIfAbsent(K key,
                              V value)

Specified by:

putIfAbsent in interface ConcurrentMap<K,V>

Specified by:

putIfAbsent in interface Map<K,V>

remove

public abstract V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMap<K,V>

remove

public abstract boolean remove(Object key,
                               Object value)

Specified by:

remove in interface ConcurrentMap<K,V>

Specified by:

remove in interface Map<K,V>

replace

public abstract boolean replace(K key,
                                V oldValue,
                                V newValue)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

replace

public abstract V replace(K key,
                          V value)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

size

public abstract int size()

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractMap<K,V>