com.saxonica.functions.trie

Class ImmutableHashTrieMap<K,V>

java.lang.Object

com.saxonica.functions.trie.ImmutableHashTrieMap<K,V>

All Implemented Interfaces:

ImmutableMap<K,V>, Iterable<Tuple2<K,V>>

public abstract class ImmutableHashTrieMap<K,V>
extends Object
implements ImmutableMap<K,V>, Iterable<Tuple2<K,V>>

Constructor Summary

Constructors

Constructor and Description
ImmutableHashTrieMap()

Method Summary

Methods

Modifier and Type	Method and Description
static <K,V> ImmutableHashTrieMap<K,V>	empty()
Option<V>	get(K key) Retrieve a stored value from the map based on the key for the associated entry.
ImmutableHashTrieMap<K,V>	put(K key, V value) Add a new entry to the map.
ImmutableHashTrieMap<K,V>	remove(K key) Remove an entry from the map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.saxonica.functions.trie.ImmutableMap

iterator

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

ImmutableHashTrieMap

public ImmutableHashTrieMap()

Method Detail

empty

public static <K,V> ImmutableHashTrieMap<K,V> empty()

put

public ImmutableHashTrieMap<K,V> put(K key,
                            V value)

Description copied from interface: ImmutableMap

Add a new entry to the map. If an entry already exists with the given key, the returned map will contain this entry, but not the existing entry.

Specified by:

put in interface ImmutableMap<K,V>

Parameters:

key - the key to use to retrieve this item

value - the value stored for this item

Returns:

a new map with this item added

remove

public ImmutableHashTrieMap<K,V> remove(K key)

Description copied from interface: ImmutableMap

Remove an entry from the map. If no entry exists with the given key, the returned map will have identical contents to the original map (and may, in fact, be the original map itself).

Specified by:

remove in interface ImmutableMap<K,V>

Parameters:

key - the key for the entry to remove

Returns:

a new map with the entry with the given key removed (or a map with the original contents if no entry was found for the given key).

get

public Option<V> get(K key)

Description copied from interface: ImmutableMap

Retrieve a stored value from the map based on the key for the associated entry. If no entry exists with the given key, we return None.

Specified by:

get in interface ImmutableMap<K,V>

Parameters:

key - the key for the entry to retrieve

Returns:

Some(value) if an entry exists with the given key, or None if no entry with the given key was found.