de.flapdoodle.formula

Class ImmutableValueContainer.Builder

java.lang.Object

de.flapdoodle.formula.ImmutableValueContainer.Builder

Enclosing class:

ImmutableValueContainer

@NotThreadSafe
public static final class ImmutableValueContainer.Builder
extends Object

Builds instances of type ImmutableValueContainer. 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
ImmutableValueContainer.Builder	addAllNullValues(Iterable<? extends Value<?>> elements) Adds elements to nullValues set.
ImmutableValueContainer.Builder	addNullValues(Value<?>... elements) Adds elements to nullValues set.
ImmutableValueContainer.Builder	addNullValues(Value<?> element) Adds one element to nullValues set.
ImmutableValueContainer	build() Builds a new ImmutableValueContainer.
ImmutableValueContainer.Builder	from(ValueContainer instance) Fill a builder with attribute values from the provided ValueContainer instance.
ImmutableValueContainer.Builder	nullValues(Iterable<? extends Value<?>> elements) Sets or replaces all elements for nullValues set.
ImmutableValueContainer.Builder	putAllValues(Map<? extends Value<?>,? extends Object> entries) Put all mappings from the specified map as entries to values map.
ImmutableValueContainer.Builder	putValues(Map.Entry<? extends Value<?>,? extends Object> entry) Put one entry to the values map.
ImmutableValueContainer.Builder	putValues(Value<?> key, Object value) Put one entry to the values map.
ImmutableValueContainer.Builder	values(Map<? extends Value<?>,? extends Object> 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

@CanIgnoreReturnValue
public final ImmutableValueContainer.Builder from(ValueContainer instance)

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

@CanIgnoreReturnValue
public final ImmutableValueContainer.Builder putValues(Value<?> key,
                                                                             Object 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

@CanIgnoreReturnValue
public final ImmutableValueContainer.Builder putValues(Map.Entry<? extends Value<?>,? extends Object> 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

@CanIgnoreReturnValue
public final ImmutableValueContainer.Builder values(Map<? extends Value<?>,? extends Object> 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

@CanIgnoreReturnValue
public final ImmutableValueContainer.Builder putAllValues(Map<? extends Value<?>,? extends Object> 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

addNullValues

@CanIgnoreReturnValue
public final ImmutableValueContainer.Builder addNullValues(Value<?> element)

Adds one element to nullValues set.

Parameters:

element - A nullValues element

Returns:

this builder for use in a chained invocation

addNullValues

@CanIgnoreReturnValue
 @SafeVarargs
public final ImmutableValueContainer.Builder addNullValues(Value<?>... elements)

Adds elements to nullValues set.

Parameters:

elements - An array of nullValues elements

Returns:

this builder for use in a chained invocation

nullValues

@CanIgnoreReturnValue
public final ImmutableValueContainer.Builder nullValues(Iterable<? extends Value<?>> elements)

Sets or replaces all elements for nullValues set.

Parameters:

elements - An iterable of nullValues elements

Returns:

this builder for use in a chained invocation

addAllNullValues

@CanIgnoreReturnValue
public final ImmutableValueContainer.Builder addAllNullValues(Iterable<? extends Value<?>> elements)

Adds elements to nullValues set.

Parameters:

elements - An iterable of nullValues elements

Returns:

this builder for use in a chained invocation

build

public ImmutableValueContainer build()

Builds a new ImmutableValueContainer.

Returns:

An immutable instance of ValueContainer

Throws:

IllegalStateException - if any required attributes are missing