de.flapdoodle.formula.solver

Class ImmutableExplanation

java.lang.Object

de.flapdoodle.formula.solver.Explanation

de.flapdoodle.formula.solver.ImmutableExplanation

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableExplanation
extends Explanation

Immutable implementation of Explanation.

Use the builder to create immutable instances: ImmutableExplanation.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableExplanation.Builder Builds instances of type ImmutableExplanation.

Nested classes/interfaces inherited from class de.flapdoodle.formula.solver.Explanation

Explanation.ExplainValue<T>

Method Summary

Modifier and Type	Method and Description
static ImmutableExplanation.Builder	builder() Creates a builder for ImmutableExplanation.
static ImmutableExplanation	copyOf(Explanation instance) Creates an immutable copy of a Explanation value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableExplanation that have equal attribute values.
int	hashCode() Computes a hash code from attributes: list.
com.google.common.collect.ImmutableList<Explanation.ExplainValue<?>>	list()
String	toString() Prints the immutable value Explanation with attribute values.
ImmutableExplanation	withList(Explanation.ExplainValue<?>... elements) Copy the current immutable object with elements that replace the content of list.
ImmutableExplanation	withList(Iterable<? extends Explanation.ExplainValue<?>> elements) Copy the current immutable object with elements that replace the content of list.

Methods inherited from class de.flapdoodle.formula.solver.Explanation

explainValue, render, render

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

list

public com.google.common.collect.ImmutableList<Explanation.ExplainValue<?>> list()

Specified by:

list in class Explanation

Returns:

The value of the list attribute

withList

@SafeVarargs
public final ImmutableExplanation withList(Explanation.ExplainValue<?>... elements)

Copy the current immutable object with elements that replace the content of list.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withList

public final ImmutableExplanation withList(Iterable<? extends Explanation.ExplainValue<?>> elements)

Copy the current immutable object with elements that replace the content of list. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of list elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableExplanation that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: list.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Explanation with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableExplanation copyOf(Explanation instance)

Creates an immutable copy of a Explanation value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable Explanation instance

builder

public static ImmutableExplanation.Builder builder()

Creates a builder for ImmutableExplanation.

 ImmutableExplanation.builder()
    .addList|addAllList(de.flapdoodle.formula.solver.Explanation.ExplainValue<?>) // list elements
    .build();
 

Returns:

A new ImmutableExplanation builder