de.flapdoodle.formula.calculate.calculations

Class ImmutableAggregated<S,X>

java.lang.Object

de.flapdoodle.formula.calculate.calculations.Aggregated<S,X>

de.flapdoodle.formula.calculate.calculations.ImmutableAggregated<S,X>

All Implemented Interfaces:

Calculation<X>, HasHumanReadableLabel

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableAggregated<S,X>
extends Aggregated<S,X>

Immutable implementation of Aggregated.

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

Method Summary

Modifier and Type	Method and Description
protected FN1<List<S>,X>	aggregation()
static <S,X> ImmutableAggregated<S,X>	copyOf(Aggregated<S,X> instance) Creates an immutable copy of a Aggregated value.
Value<X>	destination()
boolean	equals(Object another) This instance is equal to all instances of ImmutableAggregated that have equal attribute values.
int	hashCode() Computes a hash code from attributes: destination, sourceList, aggregation.
static <S,X> ImmutableAggregated<S,X>	of(Value<X> destination, Iterable<? extends ValueSource<S>> sourceList, FN1<List<S>,X> aggregation) Construct a new immutable Aggregated instance.
static <S,X> ImmutableAggregated<S,X>	of(Value<X> destination, List<ValueSource<S>> sourceList, FN1<List<S>,X> aggregation) Construct a new immutable Aggregated instance.
protected com.google.common.collect.ImmutableList<ValueSource<S>>	sourceList()
String	toString() Prints the immutable value Aggregated with attribute values.
ImmutableAggregated<S,X>	withAggregation(FN1<List<S>,X> value) Copy the current immutable object by setting a value for the aggregation attribute.
ImmutableAggregated<S,X>	withDestination(Value<X> value) Copy the current immutable object by setting a value for the destination attribute.
ImmutableAggregated<S,X>	withSourceList(Iterable<? extends ValueSource<S>> elements) Copy the current immutable object with elements that replace the content of sourceList.
ImmutableAggregated<S,X>	withSourceList(ValueSource<S>... elements) Copy the current immutable object with elements that replace the content of sourceList.

Methods inherited from class de.flapdoodle.formula.calculate.calculations.Aggregated

asHumanReadable, calculate, sources, with

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

destination

public Value<X> destination()

Returns:

The value of the destination attribute

sourceList

protected com.google.common.collect.ImmutableList<ValueSource<S>> sourceList()

Specified by:

sourceList in class Aggregated<S,X>

Returns:

The value of the sourceList attribute

aggregation

protected FN1<List<S>,X> aggregation()

Specified by:

aggregation in class Aggregated<S,X>

Returns:

The value of the aggregation attribute

withDestination

public final ImmutableAggregated<S,X> withDestination(Value<X> 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

withSourceList

@SafeVarargs
public final ImmutableAggregated<S,X> withSourceList(ValueSource<S>... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withSourceList

public final ImmutableAggregated<S,X> withSourceList(Iterable<? extends ValueSource<S>> elements)

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

Parameters:

elements - An iterable of sourceList elements to set

Returns:

A modified copy of this object

withAggregation

public final ImmutableAggregated<S,X> withAggregation(FN1<List<S>,X> value)

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

Parameters:

value - A new value for aggregation

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableAggregated 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, sourceList, aggregation.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Aggregated with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <S,X> ImmutableAggregated<S,X> of(Value<X> destination,
                                                List<ValueSource<S>> sourceList,
                                                FN1<List<S>,X> aggregation)

Construct a new immutable Aggregated instance.

Type Parameters:

S - generic parameter S

X - generic parameter X

Parameters:

destination - The value for the destination attribute

sourceList - The value for the sourceList attribute

aggregation - The value for the aggregation attribute

Returns:

An immutable Aggregated instance

of

public static <S,X> ImmutableAggregated<S,X> of(Value<X> destination,
                                                Iterable<? extends ValueSource<S>> sourceList,
                                                FN1<List<S>,X> aggregation)

Construct a new immutable Aggregated instance.

Type Parameters:

S - generic parameter S

X - generic parameter X

Parameters:

destination - The value for the destination attribute

sourceList - The value for the sourceList attribute

aggregation - The value for the aggregation attribute

Returns:

An immutable Aggregated instance

copyOf

public static <S,X> ImmutableAggregated<S,X> copyOf(Aggregated<S,X> instance)

Creates an immutable copy of a Aggregated 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:

S - generic parameter S

X - generic parameter X

Parameters:

instance - The instance to copy

Returns:

A copied immutable Aggregated instance