org.organicdesign.fp.collections

Interface ImMap<K,V>

All Superinterfaces:

BaseMap<K,V>, BaseUnsortedMap<K,V>, Iterable<UnmodMap.UnEntry<K,V>>, Map<K,V>, Sized, Transformable<UnmodMap.UnEntry<K,V>>, UnmodIterable<UnmodMap.UnEntry<K,V>>, UnmodMap<K,V>

All Known Implementing Classes:

PersistentHashMap

public interface ImMap<K,V>
extends BaseUnsortedMap<K,V>

An immutable map with no guarantees about its ordering.

Nested Class Summary

Nested classes/interfaces inherited from interface org.organicdesign.fp.collections.UnmodMap

UnmodMap.AbstractUnmodMap<K,V>, UnmodMap.UnEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Nested classes/interfaces inherited from interface org.organicdesign.fp.collections.UnmodIterable

UnmodIterable.AbstractUnmodIterable<T>

Method Summary

Modifier and Type	Method and Description
ImMap<K,V>	assoc(K key, V val) Returns a new map with the given key/value added
default ImMap<K,V>	assoc(Map.Entry<K,V> entry) Returns a new map with an immutable copy of the given entry added
default ImSet<Map.Entry<K,V>>	entrySet() Returns a view of the mappings contained in this map.
default ImSet<K>	keySet() Returns an immutable view of the keys contained in this map.
MutableUnsortedMap<K,V>	mutable() Returns a mutable version of this mutable map.
ImMap<K,V>	without(K key) Returns a new map with the given key/value removed

Methods inherited from interface org.organicdesign.fp.collections.BaseUnsortedMap

equator

Methods inherited from interface org.organicdesign.fp.collections.BaseMap

containsKey, entry, get, getOrElse

Methods inherited from interface org.organicdesign.fp.collections.UnmodMap

clear, compute, computeIfAbsent, computeIfPresent, containsValue, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, values

Methods inherited from interface java.util.Map

equals, forEach, getOrDefault, hashCode, size

Methods inherited from interface org.organicdesign.fp.collections.UnmodIterable

concat, drop, filter, flatMap, fold, foldUntil, hash, head, iterator, map, precat, take, takeWhile, toString

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.organicdesign.fp.xform.Transformable

toImList, toImMap, toImSet, toImSortedMap, toImSortedSet, toMutableList, toMutableMap, toMutableSet, toMutableSortedMap, toMutableSortedSet

Methods inherited from interface org.organicdesign.fp.collections.Sized

size

Method Detail

assoc

ImMap<K,V> assoc(K key,
                 V val)

Returns a new map with the given key/value added

Specified by:

assoc in interface BaseMap<K,V>

assoc

default ImMap<K,V> assoc(Map.Entry<K,V> entry)

Returns a new map with an immutable copy of the given entry added

Specified by:

assoc in interface BaseMap<K,V>

without

ImMap<K,V> without(K key)

Returns a new map with the given key/value removed

Specified by:

without in interface BaseMap<K,V>

entrySet

default ImSet<Map.Entry<K,V>> entrySet()

Returns a view of the mappings contained in this map. The set should actually contain UnmodMap.Entry items, but that return signature is illegal in Java, so you'll just have to remember.

Specified by:

entrySet in interface BaseMap<K,V>

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface UnmodMap<K,V>

keySet

default ImSet<K> keySet()

Returns an immutable view of the keys contained in this map.

Specified by:

keySet in interface BaseMap<K,V>

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface UnmodMap<K,V>

mutable

MutableUnsortedMap<K,V> mutable()

Returns a mutable version of this mutable map.