Type Parameters:
K - The type of the keys.
V - The type of the values.

All Superinterfaces:

IIterable<Binding<K,V>>, Iterable<Binding<K,V>>

public interface IMap<K,V> extends IIterable<Binding<K,V>>

An immutable map. Null keys and values are not permitted.

Nested Classes
	Modifier and Type	Interface and Description
	FVisitor<K,V,R>	`static interface` FVisitor<K,V,R> `static interface` FVisitor<K,V,R>
	Visitor<K,V>	`static interface` Visitor<K,V> `static interface` Visitor<K,V>

Fields
Modifier and Type Field and Description

ORDERED

static Option ORDERED

static final Option ORDERED

Static Methods
	Modifier and Type	Static Method and Description
	builder	`static <K,V> MapBuilder<K,V>` builder() Return a new map builder. static <K,V> MapBuilder<K,V> builder() Return a new map builder.
	builder	`static <K,V> MapBuilder<K,V>` builder(Option option) Return a new map builder. static <K,V> MapBuilder<K,V> builder(Option option) Return a new map builder. Parameters: `option` - If option is `ORDERED`, the iteration order of the map will be based on the order in which the keys were first added.
	cast	`static <K,V> IMap<K,V>` cast(IMap<?,?> o) Cast a map to a specific type. static <K,V> IMap<K,V> cast(IMap<?,?> o) Cast a map to a specific type. This method is no more reliable than an explicit type cast, but it prevents the warning.
	create	`static <K,V> IMap<K,V>` create(Map<? extends K,? extends V> map) Return a map containing the specified bindings. static <K,V> IMap<K,V> create(Map<? extends K,? extends V> map) Return a map containing the specified bindings.
	createWeak	`static <K,V> IMap<K,V>` createWeak(Map<? extends K,? extends V> map) Return a map containing the specified bindings using weak references to the keys. static <K,V> IMap<K,V> createWeak(Map<? extends K,? extends V> map) Return a map containing the specified bindings using weak references to the keys.
	empty	`static <K,V> IMap<K,V>` empty() Return a map containing no bindings. static <K,V> IMap<K,V> empty() Return a map containing no bindings.
	from	`static <T> IIterable<T>` from(Iterable<T> it) Create an `IIterable` from an `Iterable`. static <T> IIterable<T> from(Iterable<T> it) Description copied from interface: `IIterable` Create an `IIterable` from an `Iterable`. The iterators produced by the returned `IIterable` will throw a runtime exception if an iterator produced by the `Iterable` returns a null value. Parameters: `it` - The source iterable.
	mapListBuilder	`static <K,V> UnorderedMapListBuilder<K,V>` mapListBuilder() Return a new map list builder. static <K,V> UnorderedMapListBuilder<K,V> mapListBuilder() Return a new map list builder.
	mapListBuilder	`static <K,V> MapListBuilder<K,V>` mapListBuilder(Option option) Return a new map list builder. static <K,V> MapListBuilder<K,V> mapListBuilder(Option option) Return a new map list builder. Parameters: `option` - If option is `ORDERED`, the iteration order of the map list will be based on the order in which keys and elements were first added.
	mapSetBuilder	`static <K,V> MapSetBuilder<K,V>` mapSetBuilder() Return a new map set builder. static <K,V> MapSetBuilder<K,V> mapSetBuilder() Return a new map set builder.
	mapSetBuilder	`static <K,V> MapSetBuilder<K,V>` mapSetBuilder(Option option) Return a new map set builder. static <K,V> MapSetBuilder<K,V> mapSetBuilder(Option option) Return a new map set builder. Parameters: `option` - If option is `ORDERED`, the iteration order of the map set will be based on the order in which keys and elements were first added.
	of	`static <K,V> IMap<K,V>` of(Binding<? extends K,? extends V> binding) Return a map containing one binding. static <K,V> IMap<K,V> of(Binding<? extends K,? extends V> binding) Return a map containing one binding.
	singleton	`static <K,V> IMap<K,V>` singleton(K key, V value) Return a map containing one binding. static <K,V> IMap<K,V> singleton(K key, V value) Return a map containing one binding.

Methods
	Modifier and Type	Method and Description
	asJavaMap	`Map<K,V>` asJavaMap() Return a new Java map containing the bindings of this map. Map<K,V> asJavaMap() Return a new Java map containing the bindings of this map.
	containsKey	`abstract boolean` containsKey(Object key) boolean containsKey(Object key)
	extending	`abstract IMap<K,V>` extending(IMap<K,V> bindings) Return a map with possibly additional or updated bindings. IMap<K,V> extending(IMap<K,V> bindings) Return a map with possibly additional or updated bindings. Parameters: `bindings` - The bindings to be added to or to replace bindings in this map. Returns: A map with the existing bindings from this map, updated by the specified bindings.
	extending	`abstract IMap<K,V>` extending(K key, V value) Return a map with a possibly updated binding for the specified key. IMap<K,V> extending(K key, V value) Return a map with a possibly updated binding for the specified key. The returned map will have the same bindings for other keys as this map. Parameters: `key` - The key whose value is specified. `value` - The value to be associated with `key`. If null, the returned map will have no binding for `key`. Returns: A map with the existing bindings from this map, plus the specified binding (or lack thereof) for the key `key`.
	find	`abstract <R> R` find(IMap.FVisitor<K,V,R> visitor, R defaultResult) <R> R find(IMap.FVisitor<K,V,R> visitor, R defaultResult)
	forEach	`void` forEach(Consumer<? super T> arg0) void forEach(Consumer<? super T> arg0)
	get	`abstract V` get(K key) Return the value associated with the specified key. V get(K key) Return the value associated with the specified key. Parameters: `key` - The key. Returns: the value associated with `key`, or null if none.
	getRequired	`V` getRequired(K key) V getRequired(K key)
	isEmpty	`abstract boolean` isEmpty() Return true if and only if the map contains no keys. boolean isEmpty() Return true if and only if the map contains no keys.
	iterator	`abstract IIterator<T>` iterator() Returns an iterator over non-null elements of type `T`. IIterator<T> iterator() Description copied from interface: `IIterable` Returns an iterator over non-null elements of type `T`. Specified by: `iterator` in interface `Iterable<T>` Returns: an Iterator.
	keySet	`abstract ISet<K>` keySet() ISet<K> keySet()
	size	`abstract int` size() Return the number of keys in the map. int size() Return the number of keys in the map.
	spliterator	`Spliterator<T>` spliterator() Spliterator<T> spliterator()
	subset	`IMap<K,V>` subset(ISet<K> keys) Return a map containing the bindings for the specified keys (if defined). IMap<K,V> subset(ISet<K> keys) Return a map containing the bindings for the specified keys (if defined). Parameters: `keys` - The keys whose bindings are to be returned. Returns: A map containing the existing bindings for `keys` in this map.
	values	`abstract ISet<V>` values() ISet<V> values()
	visit	`abstract void` visit(IMap.Visitor<K,V> visitor) void visit(IMap.Visitor<K,V> visitor)