de.flapdoodle.formula.solver

Class ImmutableExplainValue<T>

java.lang.Object

de.flapdoodle.formula.solver.Explanation.ExplainValue<T>

de.flapdoodle.formula.solver.ImmutableExplainValue<T>

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableExplainValue<T>
extends Explanation.ExplainValue<T>

Immutable implementation of Explanation.ExplainValue.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableExplainValue.Builder<T> Builds instances of type ImmutableExplainValue.

Method Summary

Modifier and Type	Method and Description
static <T> ImmutableExplainValue.Builder<T>	builder() Creates a builder for ImmutableExplainValue.
Optional<Calculation<T>>	calculation()
static <T> ImmutableExplainValue<T>	copyOf(Explanation.ExplainValue<T> instance) Creates an immutable copy of a Explanation.ExplainValue value.
Value<T>	destination()
boolean	equals(Object another) This instance is equal to all instances of ImmutableExplainValue that have equal attribute values.
int	hashCode() Computes a hash code from attributes: destination, validation, calculation.
String	toString() Prints the immutable value ExplainValue with attribute values.
Optional<Validation<T>>	validation()
ImmutableExplainValue<T>	withCalculation(Calculation<T> value) Copy the current immutable object by setting a present value for the optional calculation attribute.
ImmutableExplainValue<T>	withCalculation(Optional<? extends Calculation<T>> optional) Copy the current immutable object by setting an optional value for the calculation attribute.
ImmutableExplainValue<T>	withDestination(Value<T> value) Copy the current immutable object by setting a value for the destination attribute.
ImmutableExplainValue<T>	withValidation(Optional<? extends Validation<T>> optional) Copy the current immutable object by setting an optional value for the validation attribute.
ImmutableExplainValue<T>	withValidation(Validation<T> value) Copy the current immutable object by setting a present value for the optional validation attribute.

Methods inherited from class java.lang.Object

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

Method Detail

destination

public Value<T> destination()

Specified by:

destination in class Explanation.ExplainValue<T>

Returns:

The value of the destination attribute

validation

public Optional<Validation<T>> validation()

Specified by:

validation in class Explanation.ExplainValue<T>

Returns:

The value of the validation attribute

calculation

public Optional<Calculation<T>> calculation()

Specified by:

calculation in class Explanation.ExplainValue<T>

Returns:

The value of the calculation attribute

withDestination

public final ImmutableExplainValue<T> withDestination(Value<T> value)

Copy the current immutable object by setting a value for the destination attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for destination

Returns:

A modified copy of the this object

withValidation

public final ImmutableExplainValue<T> withValidation(Validation<T> value)

Copy the current immutable object by setting a present value for the optional validation attribute.

Parameters:

value - The value for validation

Returns:

A modified copy of this object

withValidation

public final ImmutableExplainValue<T> withValidation(Optional<? extends Validation<T>> optional)

Copy the current immutable object by setting an optional value for the validation attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - A value for validation

Returns:

A modified copy of this object

withCalculation

public final ImmutableExplainValue<T> withCalculation(Calculation<T> value)

Copy the current immutable object by setting a present value for the optional calculation attribute.

Parameters:

value - The value for calculation

Returns:

A modified copy of this object

withCalculation

public final ImmutableExplainValue<T> withCalculation(Optional<? extends Calculation<T>> optional)

Copy the current immutable object by setting an optional value for the calculation attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - A value for calculation

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableExplainValue 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: destination, validation, calculation.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ExplainValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static <T> ImmutableExplainValue<T> copyOf(Explanation.ExplainValue<T> instance)

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

Type Parameters:

T - generic parameter T

Parameters:

instance - The instance to copy

Returns:

A copied immutable ExplainValue instance

builder

public static <T> ImmutableExplainValue.Builder<T> builder()

Creates a builder for ImmutableExplainValue.

 ImmutableExplainValue.<T>builder()
    .destination(de.flapdoodle.formula.Value<T>) // required destination
    .validation(de.flapdoodle.formula.validation.Validation<T>) // optional validation
    .calculation(de.flapdoodle.formula.calculate.Calculation<T>) // optional calculation
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new ImmutableExplainValue builder