de.flapdoodle.formula.calculate

Class ImmutableMappedValue<T>

java.lang.Object

de.flapdoodle.formula.calculate.ImmutableMappedValue<T>

All Implemented Interfaces:

MappedValue<T>

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableMappedValue<T>
extends Object
implements MappedValue<T>

Immutable implementation of MappedValue.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

id

public Value<T> id()

Specified by:

id in interface MappedValue<T>

Returns:

The value of the id attribute

value

@Nullable
public T value()

Specified by:

value in interface MappedValue<T>

Returns:

The value of the value attribute

withId

public final ImmutableMappedValue<T> withId(Value<T> value)

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

Parameters:

value - A new value for id

Returns:

A modified copy of the this object

withValue

public final ImmutableMappedValue<T> withValue(@Nullable
                                               T value)

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

Parameters:

value - A new value for value (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableMappedValue 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: id, value.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value MappedValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T> ImmutableMappedValue<T> of(Value<T> id,
                                             @Nullable
                                             T value)

Construct a new immutable MappedValue instance.

Specified by:

of in interface MappedValue<T>

Type Parameters:

T - generic parameter T

Parameters:

id - The value for the id attribute

value - The value for the value attribute

Returns:

An immutable MappedValue instance

copyOf

public static <T> ImmutableMappedValue<T> copyOf(MappedValue<T> instance)

Creates an immutable copy of a MappedValue 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 MappedValue instance

builder

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

Creates a builder for ImmutableMappedValue.

 ImmutableMappedValue.<T>builder()
    .id(de.flapdoodle.formula.Value<T>) // required id
    .value(T | null) // nullable value
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new ImmutableMappedValue builder