Interface Map<K,V>

All Superinterfaces:

Iterable<Pair<K,V>>, Iterable<Pair<K,V>>, Traversable<Pair<K,V>>

All Known Subinterfaces:

SortedMap<K,V>

All Known Implementing Classes:

AbstractMap, AbstractSortedMap, DerivedKeyHashMap, HashMap, ListMap, ListMap.Node, TreeMap

public interface Map<K,V>
extends Iterable<Pair<K,V>>

Map defines the interface for maps that associate keys with values.

Method Summary

Modifier and Type	Method	Description
Map<K,V>	asMap()	Returns an immutable view of this map as an instance of Map.
boolean	containsKey(K key)	Returns true if this map contains the specified key.
V	get(K key)	Returns the value associated with the key or null if the no value exists with the key specified.
@NotNull Iterable<K>	keys()	Returns the keys for this map.
@NotNull Map<K,V>	put(K key, V value)	Returns a map with the value specified associated to the key specified.
@NotNull Map<K,V>	remove(K key)	Returns a map with the value associated with the key removed if it exists.
@NotNull Iterable<V>	values()	Returns the values for this map.

Methods inherited from interface Iterable

iterator

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface Traversable

forEach, isEmpty, makeString, makeString, size, to, toArray, toArray, toIndexedList, toSet, toSortedSet

Method Details

put

@NotNull
@NotNull Map<K,V> put(@NotNull
 K key,
 V value)

Returns a map with the value specified associated to the key specified.

If value already exists for the key, it will be replaced.

get

@Nullable
V get(@NotNull
 K key)

Returns the value associated with the key or null if the no value exists with the key specified.

remove

@NotNull
@NotNull Map<K,V> remove(@NotNull
 K key)

Returns a map with the value associated with the key removed if it exists.

keys

@NotNull
@NotNull Iterable<K> keys()

Returns the keys for this map.

values

@NotNull
@NotNull Iterable<V> values()

Returns the values for this map.

containsKey

boolean containsKey(@NotNull
 K key)

Returns true if this map contains the specified key.

asMap

@NotNull
Map<K,V> asMap()

Returns an immutable view of this map as an instance of Map.