org.organicdesign.fp.collections

Interface ImUnsortedMap<K,V>

All Superinterfaces:

ImMap<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 Subinterfaces:

ImMapTrans<K,V>, MutableUnsortedMap<K,V>

All Known Implementing Classes:

PersistentHashMap, PersistentHashMap.MutableHashMap

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

Interface for unsorted (today that probably means "hash") maps.

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
ImUnsortedMap<K,V>	assoc(K key, V val) Returns a new map with the given key/value added
default ImUnsortedMap<K,V>	assoc(Map.Entry<K,V> entry) Returns a new map with an immutable copy of the given entry added
Equator<K>	equator() Returns the Equator used by this map for equals comparisons and hashCodes
ImUnsortedMap<K,V>	immutable() Returns a immutable version of this (maybe) mutable map.
default ImSet<K>	keySet() Returns a view of the keys contained in this map.
MutableUnsortedMap<K,V>	mutable() Returns a mutable version of this immutable map.
ImUnsortedMap<K,V>	without(K key) Returns a new map with the given key/value removed

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

containsKey, entry, entrySet, 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, foldLeft, foldLeft, hash, hashCode, 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

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

Returns a new map with the given key/value added

Specified by:

assoc in interface ImMap<K,V>

assoc

default ImUnsortedMap<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 ImMap<K,V>

equator

Equator<K> equator()

Returns the Equator used by this map for equals comparisons and hashCodes

immutable

ImUnsortedMap<K,V> immutable()

Returns a immutable version of this (maybe) mutable map. Maybe this should be on ImUnsortedMapTrans only, but that prevents reusing a variable to hold both a mutable and immutable map. I really wasn't sure of the right thing to do here. Sometimes you want a guaranteed mutable. Sometimes a guaranteed immutable. I suppose you can use the specific implementation class in that case. Inheritance forces you to pick one.

keySet

default ImSet<K> keySet()

Returns a view of the keys contained in this map.

Specified by:

keySet in interface ImMap<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 immutable map.

without

ImUnsortedMap<K,V> without(K key)

Returns a new map with the given key/value removed

Specified by:

without in interface ImMap<K,V>