de.flapdoodle.formula.values.domain

Class ImmutableReadOnlyValue<O,T>

java.lang.Object

de.flapdoodle.formula.values.domain.ReadOnlyValue<O,T>

de.flapdoodle.formula.values.domain.ImmutableReadOnlyValue<O,T>

All Implemented Interfaces:

HasHumanReadableLabel, Value<T>, HasId<O>, ReadableValue<O,T>, ValueSource<T>

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableReadOnlyValue<O,T>
extends ReadOnlyValue<O,T>

Immutable implementation of ReadOnlyValue.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class de.flapdoodle.formula.values.domain.ReadOnlyValue

asHumanReadable, get

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.formula.Value

named, named, ofType, ofType, relatedTo, unvalidated

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

asHumanReadable

Method Detail

id

public Id<O> id()

Specified by:

id in interface HasId<O>

Specified by:

id in class ReadOnlyValue<O,T>

Returns:

The value of the id attribute

property

protected ReadOnlyProperty<O,T> property()

Specified by:

property in class ReadOnlyValue<O,T>

Returns:

The value of the property attribute

withId

public final ImmutableReadOnlyValue<O,T> withId(Id<O> 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

withProperty

public final ImmutableReadOnlyValue<O,T> withProperty(ReadOnlyProperty<O,T> value)

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

Parameters:

value - A new value for property

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ReadOnlyValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <O,T> ImmutableReadOnlyValue<O,T> of(Id<O> id,
                                                   ReadOnlyProperty<O,T> property)

Construct a new immutable ReadOnlyValue instance.

Type Parameters:

O - generic parameter O

T - generic parameter T

Parameters:

id - The value for the id attribute

property - The value for the property attribute

Returns:

An immutable ReadOnlyValue instance

copyOf

public static <O,T> ImmutableReadOnlyValue<O,T> copyOf(ReadOnlyValue<O,T> instance)

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

O - generic parameter O

T - generic parameter T

Parameters:

instance - The instance to copy

Returns:

A copied immutable ReadOnlyValue instance

builder

public static <O,T> ImmutableReadOnlyValue.Builder<O,T> builder()

Creates a builder for ImmutableReadOnlyValue.

 ImmutableReadOnlyValue.<O, T>builder()
    .id(de.flapdoodle.formula.types.Id<O>) // required id
    .property(de.flapdoodle.formula.values.properties.ReadOnlyProperty<O, T>) // required property
    .build();
 

Type Parameters:

O - generic parameter O

T - generic parameter T

Returns:

A new ImmutableReadOnlyValue builder