de.flapdoodle.formula.solver

Class ImmutableContext.Builder

java.lang.Object

de.flapdoodle.formula.solver.ImmutableContext.Builder

Enclosing class:

ImmutableContext

@NotThreadSafe
public static final class ImmutableContext.Builder
extends Object

Builds instances of type ImmutableContext. 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
ImmutableContext	build() Builds a new ImmutableContext.
ImmutableContext.Builder	from(Context instance) Fill a builder with attribute values from the provided Context instance.
ImmutableContext.Builder	putAllValidationErrorMap(Map<? extends Value<?>,? extends ValidationError> entries) Put all mappings from the specified map as entries to validationErrorMap map.
ImmutableContext.Builder	putValidationErrorMap(Map.Entry<? extends Value<?>,? extends ValidationError> entry) Put one entry to the validationErrorMap map.
ImmutableContext.Builder	putValidationErrorMap(Value<?> key, ValidationError value) Put one entry to the validationErrorMap map.
ImmutableContext.Builder	unvalidated(ValueContainer unvalidated) Initializes the value for the unvalidated attribute.
ImmutableContext.Builder	validatedValues(ValueContainer validatedValues) Initializes the value for the validatedValues attribute.
ImmutableContext.Builder	validationErrorMap(Map<? extends Value<?>,? extends ValidationError> entries) Sets or replaces all mappings from the specified map as entries for the validationErrorMap 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 ImmutableContext.Builder from(Context instance)

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

unvalidated

@CanIgnoreReturnValue
public final ImmutableContext.Builder unvalidated(ValueContainer unvalidated)

Initializes the value for the unvalidated attribute.

If not set, this attribute will have a default value as returned by the initializer of unvalidated.

Parameters:

unvalidated - The value for unvalidated

Returns:

this builder for use in a chained invocation

validatedValues

@CanIgnoreReturnValue
public final ImmutableContext.Builder validatedValues(ValueContainer validatedValues)

Initializes the value for the validatedValues attribute.

If not set, this attribute will have a default value as returned by the initializer of validatedValues.

Parameters:

validatedValues - The value for validatedValues

Returns:

this builder for use in a chained invocation

putValidationErrorMap

@CanIgnoreReturnValue
public final ImmutableContext.Builder putValidationErrorMap(Value<?> key,
                                                                                  ValidationError value)

Put one entry to the validationErrorMap map.

Parameters:

key - The key in the validationErrorMap map

value - The associated value in the validationErrorMap map

Returns:

this builder for use in a chained invocation

putValidationErrorMap

@CanIgnoreReturnValue
public final ImmutableContext.Builder putValidationErrorMap(Map.Entry<? extends Value<?>,? extends ValidationError> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

validationErrorMap

@CanIgnoreReturnValue
public final ImmutableContext.Builder validationErrorMap(Map<? extends Value<?>,? extends ValidationError> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllValidationErrorMap

@CanIgnoreReturnValue
public final ImmutableContext.Builder putAllValidationErrorMap(Map<? extends Value<?>,? extends ValidationError> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

build

public ImmutableContext build()

Builds a new ImmutableContext.

Returns:

An immutable instance of Context

Throws:

IllegalStateException - if any required attributes are missing