de.flapdoodle.eval.example

Class ImmutableValueMap.Builder

java.lang.Object

de.flapdoodle.eval.example.ImmutableValueMap.Builder

Enclosing class:

ImmutableValueMap

public static final class ImmutableValueMap.Builder
extends Object

Builds instances of type ImmutableValueMap. 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
ImmutableValueMap	build() Builds a new ImmutableValueMap.
ImmutableValueMap.Builder	from(ValueMap instance) Fill a builder with attribute values from the provided ValueMap instance.
ImmutableValueMap.Builder	putAllValues(Map<String,? extends Value<?>> entries) Put all mappings from the specified map as entries to values map.
ImmutableValueMap.Builder	putValues(Map.Entry<String,? extends Value<?>> entry) Put one entry to the values map.
ImmutableValueMap.Builder	putValues(String key, Value<?> value) Put one entry to the values map.
ImmutableValueMap.Builder	values(Map<String,? extends Value<?>> entries) Sets or replaces all mappings from the specified map as entries for the values map.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableValueMap.Builder from(ValueMap instance)

Fill a builder with attribute values from the provided ValueMap 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

putValues

public final ImmutableValueMap.Builder putValues(String key,
                                                 Value<?> value)

Put one entry to the values map.

Parameters:

key - The key in the values map

value - The associated value in the values map

Returns:

this builder for use in a chained invocation

putValues

public final ImmutableValueMap.Builder putValues(Map.Entry<String,? extends Value<?>> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

values

public final ImmutableValueMap.Builder values(Map<String,? extends Value<?>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllValues

public final ImmutableValueMap.Builder putAllValues(Map<String,? extends Value<?>> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

build

public ImmutableValueMap build()

Builds a new ImmutableValueMap.

Returns:

An immutable instance of ValueMap

Throws:

IllegalStateException - if any required attributes are missing