org.starchartlabs.alloy.core.collections

Class MoreCollections.MapBuilder<K,V>

java.lang.Object

org.starchartlabs.alloy.core.collections.MoreCollections.MapBuilder<K,V>

Type Parameters:

K - The type of keys maintained by the resulting map

V - The type of mapped values

Enclosing class:

MoreCollections

public static final class MoreCollections.MapBuilder<K,V>
extends java.lang.Object

Builder for streamlined initialization of maps

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
java.util.Map<K,V>	build() Creates a new map from the specified values
java.util.Map<K,V>	build(java.util.function.Supplier<java.util.Map<K,V>> mapSupplier) Creates a new map from the specified values
MoreCollections.MapBuilder<K,V>	mutable() Configures the resulting map to be mutable/modifiable
MoreCollections.MapBuilder<K,V>	put(K key, V value)
MoreCollections.MapBuilder<K,V>	putAll(java.util.Map<? extends K,? extends V> m)

Methods inherited from class java.lang.Object

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

Method Detail

put

public MoreCollections.MapBuilder<K,V> put(K key,
                                           V value)

Parameters:

key - Key to add to the result of this builder

value - Values to associate with the resulting key

Returns:

This builder instance

Since:

1.0.0

putAll

public MoreCollections.MapBuilder<K,V> putAll(java.util.Map<? extends K,? extends V> m)

Parameters:

m - Existing map of values to add to the result of this builder

Returns:

This builder instance

Since:

1.0.0

mutable

public MoreCollections.MapBuilder<K,V> mutable()

Configures the resulting map to be mutable/modifiable

Returns:

This builder instance

Since:

1.0.0

build

public java.util.Map<K,V> build()

Creates a new map from the specified values

 Map<String, String> example = MoreCollections.<String, String> mapBuilder()
         .put("key", "value")
         .build();
 

Returns:

A map with the specified values/properties

Since:

1.0.0

build

public java.util.Map<K,V> build(java.util.function.Supplier<java.util.Map<K,V>> mapSupplier)

Creates a new map from the specified values

Provided for cases where the specific implementation, capacity, or other properties of the resulting map are important. Note that unless mutabliity is specified, the resulting map will be made unmodifiable

 Map<String, String> example = MoreCollections.<String, String> mapBuilder()
         .put("key", "value")
         .build(LinkedHashMap::new);
 

Parameters:

mapSupplier - Supplier which provides a map with specific required properties for use

Returns:

A map with the specified values/properties, beginning from the map obtained from the provided supplier

Since:

1.0.0