de.larssh.utils.collection

Class Maps.Builder<K,V>

java.lang.Object

de.larssh.utils.collection.Maps.Builder<K,V>

Type Parameters:

K - type of the maps key

V - type of the maps value

Enclosing class:

Maps

public static class Maps.Builder<K,V>
extends Object

Wraps around map to allow its fluent creation and modification.

Check out Maps.builder() and Maps.builder(Map) for more information.

Method Summary

Modifier and Type	Method and Description
Maps.Builder<K,V>	clear() Check out Map.clear().
Maps.Builder<K,V>	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction) Check out Map.compute(Object, BiFunction).
Maps.Builder<K,V>	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction) Check out Map.computeIfAbsent(Object, Function).
Maps.Builder<K,V>	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction) Check out Map.computeIfPresent(Object, BiFunction).
Map<K,V>	get() Returns the wrapped map
Maps.Builder<K,V>	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction) Check out Map.merge(Object, Object, BiFunction).
Maps.Builder<K,V>	put(K key, V value) Check out Map.put(Object, Object).
Maps.Builder<K,V>	putAll(Map<? extends K,? extends V> map) Check out Map.putAll(Map).
Maps.Builder<K,V>	putIfAbsent(K key, V value) Check out Map.putIfAbsent(Object, Object).
Maps.Builder<K,V>	remove(K key) Check out Map.remove(Object).
Maps.Builder<K,V>	remove(K key, V value) Check out Map.remove(Object, Object).
Maps.Builder<K,V>	replace(K key, V value) Check out Map.replace(Object, Object).
Maps.Builder<K,V>	replace(K key, V oldValue, V newValue) Check out Map.replace(Object, Object, Object).
Maps.Builder<K,V>	replaceAll(BiFunction<? super K,? super V,? extends V> function) Check out Map.replaceAll(BiFunction).
Map<K,V>	unmodifiable() Returns the wrapped map as unmodifiable map

Methods inherited from class java.lang.Object

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

Method Detail

clear

public Maps.Builder<K,V> clear()

Check out Map.clear().

Returns:

this builder

compute

public Maps.Builder<K,V> compute(@Nullable
                                 K key,
                                 BiFunction<? super K,? super V,? extends V> remappingFunction)

Check out Map.compute(Object, BiFunction).

Parameters:

key - key with which the specified value is to be associated

remappingFunction - the function to compute a value

Returns:

this builder

computeIfAbsent

public Maps.Builder<K,V> computeIfAbsent(@Nullable
                                         K key,
                                         Function<? super K,? extends V> mappingFunction)

Check out Map.computeIfAbsent(Object, Function).

Parameters:

key - key with which the specified value is to be associated

mappingFunction - the function to compute a value

Returns:

this builder

computeIfPresent

public Maps.Builder<K,V> computeIfPresent(@Nullable
                                          K key,
                                          BiFunction<? super K,? super V,? extends V> remappingFunction)

Check out Map.computeIfPresent(Object, BiFunction).

Parameters:

key - key with which the specified value is to be associated

remappingFunction - the function to compute a value

Returns:

this builder

get

public Map<K,V> get()

Returns the wrapped map

Returns:

the map

merge

public Maps.Builder<K,V> merge(@Nullable
                               K key,
                               @Nullable
                               V value,
                               BiFunction<? super V,? super V,? extends V> remappingFunction)

Check out Map.merge(Object, Object, BiFunction).

Parameters:

key - key with which the resulting value is to be associated

value - the non-null value to be merged with the existing value associated with the key or, if no existing value or a null value is associated with the key, to be associated with the key

remappingFunction - the function to recompute a value if present

Returns:

this builder

put

public Maps.Builder<K,V> put(@Nullable
                             K key,
                             @Nullable
                             V value)

Check out Map.put(Object, Object).

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

this builder

putAll

public Maps.Builder<K,V> putAll(Map<? extends K,? extends V> map)

Check out Map.putAll(Map).

Parameters:

map - mappings to be stored in this map

Returns:

this builder

putIfAbsent

public Maps.Builder<K,V> putIfAbsent(@Nullable
                                     K key,
                                     @Nullable
                                     V value)

Check out Map.putIfAbsent(Object, Object).

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

this builder

remove

public Maps.Builder<K,V> remove(@Nullable
                                K key)

Check out Map.remove(Object).

Parameters:

key - key whose mapping is to be removed from the map

Returns:

this builder

remove

public Maps.Builder<K,V> remove(@Nullable
                                K key,
                                @Nullable
                                V value)

Check out Map.remove(Object, Object).

Parameters:

key - key with which the specified value is associated

value - value expected to be associated with the specified key

Returns:

this builder

replace

public Maps.Builder<K,V> replace(@Nullable
                                 K key,
                                 @Nullable
                                 V value)

Check out Map.replace(Object, Object).

Parameters:

key - key with which the specified value is associated

value - value to be associated with the specified key

Returns:

this builder

replace

public Maps.Builder<K,V> replace(@Nullable
                                 K key,
                                 @Nullable
                                 V oldValue,
                                 @Nullable
                                 V newValue)

Check out Map.replace(Object, Object, Object).

Parameters:

key - key with which the specified value is associated

oldValue - value expected to be associated with the specified key

newValue - value to be associated with the specified key

Returns:

this builder

replaceAll

public Maps.Builder<K,V> replaceAll(BiFunction<? super K,? super V,? extends V> function)

Check out Map.replaceAll(BiFunction).

Parameters:

function - the function to apply to each entry

Returns:

this builder

unmodifiable

public Map<K,V> unmodifiable()

Returns the wrapped map as unmodifiable map

Returns:

unmodifiable map