com.github.andrewoma.dexx.collection

Interface Map<K,V>

All Superinterfaces:

java.lang.Iterable<Pair<K,V>>, Traversable<Pair<K,V>>

All Known Subinterfaces:

SortedMap<K,V>

All Known Implementing Classes:

AbstractMap, AbstractSortedMap, DerivedKeyHashMap, HashMap, ListMap, 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 and Description
java.util.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.
Iterable<K>	keys() Returns the keys for this map.
Map<K,V>	put(K key, V value) Returns a map with the value specified associated to the key specified.
Map<K,V>	remove(K key) Returns a map with the value associated with the key removed if it exists.
Iterable<V>	values() Returns the values for this map.

Methods inherited from interface com.github.andrewoma.dexx.collection.Iterable

iterator

Methods inherited from interface com.github.andrewoma.dexx.collection.Traversable

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

put

@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
Map<K,V> remove(@NotNull
                         K key)

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

keys

@NotNull
Iterable<K> keys()

Returns the keys for this map.

values

@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
java.util.Map<K,V> asMap()

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