org.sonar.java.collections

Interface PMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Known Implementing Classes:

AVLTree

public interface PMap<K,V>

Persistent (functional) Map.

Author:

Evgeny Mandrikov

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PMap.Consumer<K,V> Represents an operation that accepts two input arguments and returns no result.

Method Summary

Modifier and Type	Method and Description
Iterator<Map.Entry<K,V>>	entriesIterator() Iterates over all elements.
void	forEach(PMap.Consumer<K,V> action) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
V	get(K key)
boolean	isEmpty()
PMap<K,V>	put(K key, V value)
PMap<K,V>	remove(K key)

Method Detail

put

PMap<K,V> put(K key,
              V value)

Returns:

new map with added key-value pair

remove

PMap<K,V> remove(K key)

Returns:

new map with removed key, or this if map does not contain given key

get

@Nullable
V get(K key)

Returns:

value associated with given key, or null if not found

forEach

void forEach(PMap.Consumer<K,V> action)

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.

entriesIterator

Iterator<Map.Entry<K,V>> entriesIterator()

Iterates over all elements.

isEmpty

boolean isEmpty()

Returns:

true if this map contains no elements