Package org.javimmutable.collections.common

Interface CollisionMap<K,V>

All Known Implementing Classes:

ListCollisionMap, TreeCollisionMap

public interface CollisionMap<K,V>

Interface for simple collection objects that manage the contents of leaf nodes in the hash table. Implementations are free to use any class for their leaf nodes and manage them as needed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CollisionMap.Node

Method Summary

Modifier and Type	Method	Description
CollisionMap.Node	delete(CollisionMap.Node node, K key)
CollisionMap.Node	dual(K key1, V value1, K key2, V value2)
CollisionMap.Node	empty()
Maybe<IMapEntry<K,V>>	findEntry(CollisionMap.Node node, K key)
Maybe<V>	findValue(CollisionMap.Node node, K key)
IMapEntry<K,V>	first(CollisionMap.Node node)
void	forEach(CollisionMap.Node node, Proc2<K,V> proc)
<E extends Exception> void	forEachThrows(CollisionMap.Node node, Proc2Throws<K,V,E> proc)
default GenericIterator.Iterable<IMapEntry<K,V>>	genericIterable(CollisionMap.Node node)
V	getValueOr(CollisionMap.Node node, K key, V defaultValue)
default SplitableIterable<IMapEntry<K,V>>	iterable(CollisionMap.Node node)
GenericIterator.State<IMapEntry<K,V>>	iterateOverRange(CollisionMap.Node node, GenericIterator.State<IMapEntry<K,V>> parent, int offset, int limit)
default SplitableIterator<IMapEntry<K,V>>	iterator(CollisionMap.Node node)
<R> R	reduce(CollisionMap.Node node, R sum, Sum2<K,V,R> proc)
<R, E extends Exception> R	reduceThrows(CollisionMap.Node node, R sum, Sum2Throws<K,V,R,E> proc)
CollisionMap.Node	single(K key, V value)
int	size(CollisionMap.Node node)
CollisionMap.Node	update(CollisionMap.Node node, K key, Func1<Maybe<V>,V> generator)
CollisionMap.Node	update(CollisionMap.Node node, K key, V value)

Method Details

empty

@Nonnull
CollisionMap.Node empty()

single

@Nonnull
CollisionMap.Node single(@Nonnull
 K key,
 @Nullable
 V value)

dual

@Nonnull
CollisionMap.Node dual(@Nonnull
 K key1,
 @Nullable
 V value1,
 @Nonnull
 K key2,
 @Nullable
 V value2)

size

int size(@Nonnull
 CollisionMap.Node node)

update

@Nonnull
CollisionMap.Node update(@Nonnull
 CollisionMap.Node node,
 @Nonnull
 K key,
 @Nullable
 V value)

update

@Nonnull
CollisionMap.Node update(@Nonnull
 CollisionMap.Node node,
 @Nonnull
 K key,
 @Nonnull
 Func1<Maybe<V>,V> generator)

delete

@Nonnull
CollisionMap.Node delete(@Nonnull
 CollisionMap.Node node,
 @Nonnull
 K key)

getValueOr

V getValueOr(@Nonnull
 CollisionMap.Node node,
 @Nonnull
 K key,
 V defaultValue)

findValue

@Nonnull
Maybe<V> findValue(@Nonnull
 CollisionMap.Node node,
 @Nonnull
 K key)

findEntry

@Nonnull
Maybe<IMapEntry<K,V>> findEntry(@Nonnull
 CollisionMap.Node node,
 @Nonnull
 K key)

first

@Nonnull
IMapEntry<K,V> first(@Nonnull
 CollisionMap.Node node)

iterateOverRange

@Nullable
GenericIterator.State<IMapEntry<K,V>> iterateOverRange(@Nonnull
 CollisionMap.Node node,
 @Nullable
 GenericIterator.State<IMapEntry<K,V>> parent,
 int offset,
 int limit)

genericIterable

@Nonnull
default GenericIterator.Iterable<IMapEntry<K,V>> genericIterable(@Nonnull
 CollisionMap.Node node)

iterable

@Nonnull
default SplitableIterable<IMapEntry<K,V>> iterable(@Nonnull
 CollisionMap.Node node)

iterator

@Nonnull
default SplitableIterator<IMapEntry<K,V>> iterator(@Nonnull
 CollisionMap.Node node)

forEach

void forEach(@Nonnull
 CollisionMap.Node node,
 @Nonnull
 Proc2<K,V> proc)

forEachThrows

<E extends Exception> void forEachThrows(@Nonnull
 CollisionMap.Node node,
 @Nonnull
 Proc2Throws<K,V,E> proc)
                                  throws E

Throws:

E

reduce

<R> R reduce(@Nonnull
 CollisionMap.Node node,
 R sum,
 @Nonnull
 Sum2<K,V,R> proc)

reduceThrows

<R,
E extends Exception> R reduceThrows(@Nonnull
 CollisionMap.Node node,
 R sum,
 @Nonnull
 Sum2Throws<K,V,R,E> proc)
                                 throws E

Throws:

E