de.flapdoodle.formula.calculate.calculations

Class ImmutableMap1<A,X>

java.lang.Object

de.flapdoodle.formula.calculate.calculations.Map1<A,X>

de.flapdoodle.formula.calculate.calculations.ImmutableMap1<A,X>

All Implemented Interfaces:

Calculation<X>, HasHumanReadableLabel

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableMap1<A,X>
extends Map1<A,X>

Immutable implementation of Map1.

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

Method Summary

Modifier and Type	Method and Description
static <A,X> ImmutableMap1<A,X>	copyOf(Map1<A,X> instance) Creates an immutable copy of a Map1 value.
Value<X>	destination()
boolean	equals(Object another) This instance is equal to all instances of ImmutableMap1 that have equal attribute values.
int	hashCode() Computes a hash code from attributes: destination, source, transformation.
static <A,X> ImmutableMap1<A,X>	of(Value<X> destination, ValueSource<A> source, FN1<A,X> transformation) Construct a new immutable Map1 instance.
protected ValueSource<A>	source()
String	toString() Prints the immutable value Map1 with attribute values.
protected FN1<A,X>	transformation()
ImmutableMap1<A,X>	withDestination(Value<X> value) Copy the current immutable object by setting a value for the destination attribute.
ImmutableMap1<A,X>	withSource(ValueSource<A> value) Copy the current immutable object by setting a value for the source attribute.
ImmutableMap1<A,X>	withTransformation(FN1<A,X> value) Copy the current immutable object by setting a value for the transformation attribute.

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

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

source

protected ValueSource<A> source()

Specified by:

source in class Map1<A,X>

Returns:

The value of the source attribute

transformation

protected FN1<A,X> transformation()

Specified by:

transformation in class Map1<A,X>

Returns:

The value of the transformation attribute

withDestination

public final ImmutableMap1<A,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

withSource

public final ImmutableMap1<A,X> withSource(ValueSource<A> value)

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

Parameters:

value - A new value for source

Returns:

A modified copy of the this object

withTransformation

public final ImmutableMap1<A,X> withTransformation(FN1<A,X> value)

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

Parameters:

value - A new value for transformation

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableMap1 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, source, transformation.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Map1 with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <A,X> ImmutableMap1<A,X> of(Value<X> destination,
                                          ValueSource<A> source,
                                          FN1<A,X> transformation)

Construct a new immutable Map1 instance.

Type Parameters:

A - generic parameter A

X - generic parameter X

Parameters:

destination - The value for the destination attribute

source - The value for the source attribute

transformation - The value for the transformation attribute

Returns:

An immutable Map1 instance

copyOf

public static <A,X> ImmutableMap1<A,X> copyOf(Map1<A,X> instance)

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

A - generic parameter A

X - generic parameter X

Parameters:

instance - The instance to copy

Returns:

A copied immutable Map1 instance