de.flapdoodle.collections

Class GeneratedImmutableTypedMap.Builder<K>

java.lang.Object

de.flapdoodle.collections.GeneratedImmutableTypedMap.Builder<K>

Enclosing class:

GeneratedImmutableTypedMap<K>

public static final class GeneratedImmutableTypedMap.Builder<K>
extends Object

Builds instances of type GeneratedImmutableTypedMap. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
GeneratedImmutableTypedMap<K>	build() Builds a new GeneratedImmutableTypedMap.
GeneratedImmutableTypedMap.Builder<K>	from(ImmutableTypedMap<K> instance) Fill a builder with attribute values from the provided ImmutableTypedMap instance.
GeneratedImmutableTypedMap.Builder<K>	map(Map<? extends Pair<K,? extends TypeInfo<?>>,? extends Object> entries) Sets or replaces all mappings from the specified map as entries for the map map.
GeneratedImmutableTypedMap.Builder<K>	putAllMap(Map<? extends Pair<K,? extends TypeInfo<?>>,? extends Object> entries) Put all mappings from the specified map as entries to map map.
GeneratedImmutableTypedMap.Builder<K>	putMap(Map.Entry<? extends Pair<K,? extends TypeInfo<?>>,? extends Object> entry) Put one entry to the map map.
GeneratedImmutableTypedMap.Builder<K>	putMap(Pair<K,? extends TypeInfo<?>> key, Object value) Put one entry to the map map.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final GeneratedImmutableTypedMap.Builder<K> from(ImmutableTypedMap<K> instance)

Fill a builder with attribute values from the provided ImmutableTypedMap instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

putMap

public final GeneratedImmutableTypedMap.Builder<K> putMap(Pair<K,? extends TypeInfo<?>> key,
                                                          Object value)

Put one entry to the map map.

Parameters:

key - The key in the map map

value - The associated value in the map map

Returns:

this builder for use in a chained invocation

putMap

public final GeneratedImmutableTypedMap.Builder<K> putMap(Map.Entry<? extends Pair<K,? extends TypeInfo<?>>,? extends Object> entry)

Put one entry to the map map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

map

public final GeneratedImmutableTypedMap.Builder<K> map(Map<? extends Pair<K,? extends TypeInfo<?>>,? extends Object> entries)

Sets or replaces all mappings from the specified map as entries for the map map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the map map

Returns:

this builder for use in a chained invocation

putAllMap

public final GeneratedImmutableTypedMap.Builder<K> putAllMap(Map<? extends Pair<K,? extends TypeInfo<?>>,? extends Object> entries)

Put all mappings from the specified map as entries to map map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the map map

Returns:

this builder for use in a chained invocation

build

public GeneratedImmutableTypedMap<K> build()

Builds a new GeneratedImmutableTypedMap.

Returns:

An immutable instance of ImmutableTypedMap

Throws:

IllegalStateException - if any required attributes are missing