org.organicdesign.fp.collections

Class PersistentHashMap.MutableHashMap<K,V>

java.lang.Object

org.organicdesign.fp.collections.UnmodIterable.AbstractUnmodIterable<UnmodMap.UnEntry<K,V>>

org.organicdesign.fp.collections.UnmodMap.AbstractUnmodMap<K,V>

org.organicdesign.fp.collections.PersistentHashMap.MutableHashMap<K,V>

All Implemented Interfaces:

Iterable<UnmodMap.UnEntry<K,V>>, Map<K,V>, ImMap<K,V>, ImUnsortedMap<K,V>, MutableUnsortedMap<K,V>, Sized, UnmodIterable<UnmodMap.UnEntry<K,V>>, UnmodMap<K,V>, Transformable<UnmodMap.UnEntry<K,V>>

Enclosing class:

PersistentHashMap<K,V>

public static final class PersistentHashMap.MutableHashMap<K,V>
extends UnmodMap.AbstractUnmodMap<K,V>
implements MutableUnsortedMap<K,V>

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
PersistentHashMap.MutableHashMap<K,V>	assoc(K key, V val) Returns a new map with the given key/value added
Option<UnmodMap.UnEntry<K,V>>	entry(K key)
Equator<K>	equator() Returns the Equator used by this map for equals comparisons and hashCodes
PersistentHashMap<K,V>	immutable() Returns a immutable version of this (maybe) mutable map.
UnmodIterator<UnmodMap.UnEntry<K,V>>	iterator() A one-time use, mutable, not-thread-safe way to get each value of the underling collection in turn.
int	size() Returns the number of items in this iterable.
PersistentHashMap.MutableHashMap<K,V>	without(K key) Returns a new map with the given key/value removed

Methods inherited from class org.organicdesign.fp.collections.UnmodMap.AbstractUnmodMap

equals

Methods inherited from class org.organicdesign.fp.collections.UnmodIterable.AbstractUnmodIterable

hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

assoc, mutable

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

keySet

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

containsKey, 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

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

concat, drop, filter, flatMap, foldLeft, foldLeft, hash, hashCode, head, 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

Method Detail

equator

public Equator<K> equator()

Description copied from interface: ImUnsortedMap

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

Specified by:

equator in interface ImUnsortedMap<K,V>

assoc

public PersistentHashMap.MutableHashMap<K,V> assoc(K key,
                                                   V val)

Description copied from interface: MutableUnsortedMap

Returns a new map with the given key/value added

Specified by:

assoc in interface ImMap<K,V>

Specified by:

assoc in interface ImUnsortedMap<K,V>

Specified by:

assoc in interface MutableUnsortedMap<K,V>

entry

public Option<UnmodMap.UnEntry<K,V>> entry(K key)

Specified by:

entry in interface ImMap<K,V>

iterator

public UnmodIterator<UnmodMap.UnEntry<K,V>> iterator()

Description copied from interface: UnmodIterable

A one-time use, mutable, not-thread-safe way to get each value of the underling collection in turn. I experimented with various thread-safe alternatives, but the JVM is optimized around iterators so this is the lowest common denominator of collection iteration, even though iterators are inherently mutable.

Specified by:

iterator in interface Iterable<UnmodMap.UnEntry<K,V>>

Specified by:

iterator in interface UnmodIterable<UnmodMap.UnEntry<K,V>>

without

public final PersistentHashMap.MutableHashMap<K,V> without(K key)

Description copied from interface: MutableUnsortedMap

Returns a new map with the given key/value removed

Specified by:

without in interface ImMap<K,V>

Specified by:

without in interface ImUnsortedMap<K,V>

Specified by:

without in interface MutableUnsortedMap<K,V>

immutable

public final PersistentHashMap<K,V> immutable()

Description copied from interface: ImUnsortedMap

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.

Specified by:

immutable in interface ImUnsortedMap<K,V>

size

public final int size()

Description copied from interface: Sized

Returns the number of items in this iterable.

Specified by:

size in interface Map<K,V>

Specified by:

size in interface Sized