de.flapdoodle.formula.values

Class ImmutableRelated<T,B>

java.lang.Object

de.flapdoodle.formula.values.Related<T,B>

de.flapdoodle.formula.values.ImmutableRelated<T,B>

All Implemented Interfaces:

HasHumanReadableLabel, Value<T>, ValueSink<T>, ValueSource<T>

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableRelated<T,B>
extends Related<T,B>

Immutable implementation of Related.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class de.flapdoodle.formula.values.Related

asHumanReadable, to

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.formula.Value

named, ofType, relatedTo, unvalidated

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

asHumanReadable

Method Detail

destination

protected Value<T> destination()

Specified by:

destination in class Related<T,B>

Returns:

The value of the destination attribute

reference

protected B reference()

Specified by:

reference in class Related<T,B>

Returns:

The value of the reference attribute

withDestination

public final ImmutableRelated<T,B> 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

withReference

public final ImmutableRelated<T,B> withReference(B value)

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

Parameters:

value - A new value for reference

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableRelated 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, reference.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Related with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T,B> ImmutableRelated<T,B> of(Value<T> destination,
                                             B reference)

Construct a new immutable Related instance.

Type Parameters:

T - generic parameter T

B - generic parameter B

Parameters:

destination - The value for the destination attribute

reference - The value for the reference attribute

Returns:

An immutable Related instance

copyOf

public static <T,B> ImmutableRelated<T,B> copyOf(Related<T,B> instance)

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

B - generic parameter B

Parameters:

instance - The instance to copy

Returns:

A copied immutable Related instance

builder

public static <T,B> ImmutableRelated.Builder<T,B> builder()

Creates a builder for ImmutableRelated.

 ImmutableRelated.<T, B>builder()
    .destination(de.flapdoodle.formula.Value<T>) // required destination
    .reference(B) // required reference
    .build();
 

Type Parameters:

T - generic parameter T

B - generic parameter B

Returns:

A new ImmutableRelated builder