de.tudresden.inf.lat.util.map

Interface OptMap<K,V>

Type Parameters:

K - type of keys in this map

V - type of mapped values

All Known Implementing Classes:

OptMapImpl

public interface OptMap<K,V>

An object implementing this interface wraps a map with two conditions: (1) no null value is accepted nor returned and (2) the methods that verify containment accept only objects of type K or V.

Author:

Julian Mendez

Method Summary

Modifier and Type	Method and Description
Map<K,V>	asMap() Returns this as a Map.
void	clear() Clears this map.
boolean	containsKey(K key) Returns true if and only if this map contains a mapping for the given key.
boolean	containsValue(V value) Returns true if and only if this map associates one or more keys to the given value.
Set<Map.Entry<K,V>>	entrySet() Returns a set of associations.
Optional<V>	get(K key) Returns an optional containing the value associated to the given key, is this association exists, or an empty optional otherwise.
boolean	isEmpty() Returns true if and only if this map is empty.
Set<K>	keySet() Returns the set of keys.
Optional<V>	put(K key, V value) Associates the given value with the given key.
void	putAll(Map<? extends K,? extends V> m) Adds all the associations given in the specified map.
Optional<V>	remove(K key) Removes the mapping for the given key.
int	size() Returns the size of this map.
Collection<V>	values() Returns the collection of values.

Method Detail

size

int size()

Returns the size of this map.

Returns:

the size of this map

isEmpty

boolean isEmpty()

Returns true if and only if this map is empty.

Returns:

true if and only if this map is empty

containsKey

boolean containsKey(K key)

Returns true if and only if this map contains a mapping for the given key. This method replaces Map.containsKey(Object).

Parameters:

key - key

Returns:

true if and only if this map contains a mapping for the given key

Throws:

NullPointerException - if a null value is given

containsValue

boolean containsValue(V value)

Returns true if and only if this map associates one or more keys to the given value. This method replaces Map.containsValue(Object).

Parameters:

value - value

Returns:

true if and only if this map associates one or more keys to the given value

Throws:

NullPointerException - if a null value is given

get

Optional<V> get(K key)

Returns an optional containing the value associated to the given key, is this association exists, or an empty optional otherwise. This method replaces Map.get(Object).

Parameters:

key - key

Returns:

an optional containing the value associated to the given key, is this association exists, or an empty optional otherwise

put

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

Associates the given value with the given key. This method replaces put(K, V).

Parameters:

key - key

value - value

Returns:

an optional containing the previous associated value for the given key, or an empty optional if there was no mapping for that key

Throws:

NullPointerException - if a null value is given

remove

Optional<V> remove(K key)

Removes the mapping for the given key. This method replaces Map.remove(Object).

Parameters:

key - key

Returns:

an optional containing the previous associated value for the given key, or an empty optional if there was no mapping for that key

Throws:

NullPointerException - if a null value is given

clear

void clear()

Clears this map.

putAll

void putAll(Map<? extends K,? extends V> m)

Adds all the associations given in the specified map.

Parameters:

m - map containing associations

keySet

Set<K> keySet()

Returns the set of keys.

Returns:

the set of keys

values

Collection<V> values()

Returns the collection of values.

Returns:

the collection of values

entrySet

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

Returns a set of associations.

Returns:

a set of associations

asMap

Map<K,V> asMap()

Returns this as a Map.

Returns:

this as a Map