de.flapdoodle.formula.explain

Class ImmutableCalculationVertex<T>

java.lang.Object

de.flapdoodle.formula.explain.RuleVertex

de.flapdoodle.formula.explain.RuleVertex.CalculationVertex<T>

de.flapdoodle.formula.explain.ImmutableCalculationVertex<T>

All Implemented Interfaces:

HasHumanReadableLabel

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableCalculationVertex<T>
extends RuleVertex.CalculationVertex<T>

Immutable implementation of RuleVertex.CalculationVertex.

Use the builder to create immutable instances: ImmutableCalculationVertex.builder(). Use the static factory method to create immutable instances: ImmutableCalculationVertex.of().

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class de.flapdoodle.formula.explain.RuleVertex

RuleVertex.CalculationVertex<T>, RuleVertex.ValidationVertex<T>, RuleVertex.ValueVertex<T>

Method Summary

Modifier and Type	Method and Description
static <T> ImmutableCalculationVertex.Builder<T>	builder() Creates a builder for ImmutableCalculationVertex.
Calculation<T>	calculation()
static <T> ImmutableCalculationVertex<T>	copyOf(RuleVertex.CalculationVertex<T> instance) Creates an immutable copy of a RuleVertex.CalculationVertex value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableCalculationVertex that have equal attribute values.
int	hashCode() Computes a hash code from attributes: calculation.
static <T> ImmutableCalculationVertex<T>	of(Calculation<T> calculation) Construct a new immutable CalculationVertex instance.
String	toString() Prints the immutable value CalculationVertex with attribute values.
ImmutableCalculationVertex<T>	withCalculation(Calculation<T> value) Copy the current immutable object by setting a value for the calculation attribute.

Methods inherited from class de.flapdoodle.formula.explain.RuleVertex.CalculationVertex

asHumanReadable

Methods inherited from class de.flapdoodle.formula.explain.RuleVertex

calculation, validation, value

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.formula.types.HasHumanReadableLabel

asHumanReadable

Method Detail

calculation

public Calculation<T> calculation()

Specified by:

calculation in class RuleVertex.CalculationVertex<T>

Returns:

The value of the calculation attribute

withCalculation

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

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

Parameters:

value - A new value for calculation

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableCalculationVertex 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: calculation.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CalculationVertex with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T> ImmutableCalculationVertex<T> of(Calculation<T> calculation)

Construct a new immutable CalculationVertex instance.

Type Parameters:

T - generic parameter T

Parameters:

calculation - The value for the calculation attribute

Returns:

An immutable CalculationVertex instance

copyOf

public static <T> ImmutableCalculationVertex<T> copyOf(RuleVertex.CalculationVertex<T> instance)

Creates an immutable copy of a RuleVertex.CalculationVertex 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 CalculationVertex instance

builder

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

Creates a builder for ImmutableCalculationVertex.

 ImmutableCalculationVertex.<T>builder()
    .calculation(de.flapdoodle.formula.calculate.Calculation<T>) // required calculation
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new ImmutableCalculationVertex builder