de.flapdoodle.formula.solver

Class ImmutableExplanation.Builder

java.lang.Object

de.flapdoodle.formula.solver.ImmutableExplanation.Builder

Enclosing class:

ImmutableExplanation

@NotThreadSafe
public static final class ImmutableExplanation.Builder
extends Object

Builds instances of type ImmutableExplanation. 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
ImmutableExplanation.Builder	addAllList(Iterable<? extends Explanation.ExplainValue<?>> elements) Adds elements to list list.
ImmutableExplanation.Builder	addList(Explanation.ExplainValue<?>... elements) Adds elements to list list.
ImmutableExplanation.Builder	addList(Explanation.ExplainValue<?> element) Adds one element to list list.
ImmutableExplanation	build() Builds a new ImmutableExplanation.
ImmutableExplanation.Builder	from(Explanation instance) Fill a builder with attribute values from the provided Explanation instance.
ImmutableExplanation.Builder	list(Iterable<? extends Explanation.ExplainValue<?>> elements) Sets or replaces all elements for list list.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableExplanation.Builder from(Explanation instance)

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

addList

@CanIgnoreReturnValue
public final ImmutableExplanation.Builder addList(Explanation.ExplainValue<?> element)

Adds one element to list list.

Parameters:

element - A list element

Returns:

this builder for use in a chained invocation

addList

@CanIgnoreReturnValue
 @SafeVarargs
public final ImmutableExplanation.Builder addList(Explanation.ExplainValue<?>... elements)

Adds elements to list list.

Parameters:

elements - An array of list elements

Returns:

this builder for use in a chained invocation

list

@CanIgnoreReturnValue
public final ImmutableExplanation.Builder list(Iterable<? extends Explanation.ExplainValue<?>> elements)

Sets or replaces all elements for list list.

Parameters:

elements - An iterable of list elements

Returns:

this builder for use in a chained invocation

addAllList

@CanIgnoreReturnValue
public final ImmutableExplanation.Builder addAllList(Iterable<? extends Explanation.ExplainValue<?>> elements)

Adds elements to list list.

Parameters:

elements - An iterable of list elements

Returns:

this builder for use in a chained invocation

build

public ImmutableExplanation build()

Builds a new ImmutableExplanation.

Returns:

An immutable instance of Explanation

Throws:

IllegalStateException - if any required attributes are missing