Package org.javimmutable.collections.hash

Class HashMap.Builder<K,V>

java.lang.Object

org.javimmutable.collections.hash.HashMap.Builder<K,V>

All Implemented Interfaces:

ArrayAssignMapper<K,V,ArrayMapNode<K,V>>, ArraySizeMapper<ArrayMapNode<K,V>>, IMapBuilder<K,V>

Enclosing class:

HashMap<T,K,V>

@ThreadSafe
public static class HashMap.Builder<K,V>
extends Object
implements IMapBuilder<K,V>, ArrayAssignMapper<K,V,ArrayMapNode<K,V>>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IMapBuilder<K,V>	add(K key, V value)
IMap<K,V>	build()
IMapBuilder<K,V>	clear()	Deletes all values.
ArrayMapNode<K,V>	mappedAssign(K key, V value)	Called during assign operation to create a new mapping for the given key and value.
ArrayMapNode<K,V>	mappedAssign(ArrayMapNode<K,V> current, K key, V value)	Called during assign operation to replace an existing mapping for the given key and value.
int	mappedSize(ArrayMapNode<K,V> mapping)	Called to obtain number of keys in a given mapping.
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javimmutable.collections.IMapBuilder

add, add, add, add, add, add, add, add

Constructor Details

Builder

public Builder()

Method Details

build

@Nonnull
public IMap<K,V> build()

Specified by:

build in interface IMapBuilder<K,V>

clear

@Nonnull
public IMapBuilder<K,V> clear()

Description copied from interface: IMapBuilder

Deletes all values. This is useful to reset to build a new map with the same builder.

Specified by:

clear in interface IMapBuilder<K,V>

Returns:

the builder (convenience for chaining multiple calls)

add

@Nonnull
public IMapBuilder<K,V> add(@Nonnull
 K key,
 V value)

Specified by:

add in interface IMapBuilder<K,V>

size

public int size()

Specified by:

size in interface IMapBuilder<K,V>

mappedAssign

@Nonnull
public ArrayMapNode<K,V> mappedAssign(@Nonnull
 K key,
 V value)

Description copied from interface: ArrayAssignMapper

Called during assign operation to create a new mapping for the given key and value.

Specified by:

mappedAssign in interface ArrayAssignMapper<K,V,ArrayMapNode<K,V>>

Parameters:

key - key being assigned to

value - value being assigned

Returns:

non-null mapping

mappedAssign

@Nonnull
public ArrayMapNode<K,V> mappedAssign(@Nonnull
 ArrayMapNode<K,V> current,
 @Nonnull
 K key,
 V value)

Description copied from interface: ArrayAssignMapper

Called during assign operation to replace an existing mapping for the given key and value.

Specified by:

mappedAssign in interface ArrayAssignMapper<K,V,ArrayMapNode<K,V>>

Parameters:

current - mapping to be replaced

key - key being assigned to

value - value being assigned

Returns:

same to keep mapping or non-null to replace mapping

mappedSize

public int mappedSize(@Nonnull
 ArrayMapNode<K,V> mapping)

Description copied from interface: ArraySizeMapper

Called to obtain number of keys in a given mapping.

Specified by:

mappedSize in interface ArraySizeMapper<K>

Parameters:

mapping - mapping to be sized

Returns:

number of keys in the mapping