de.flapdoodle.formula.values

Class ImmutableNamed<T>

java.lang.Object

de.flapdoodle.formula.values.Named<T>

de.flapdoodle.formula.values.ImmutableNamed<T>

All Implemented Interfaces:

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

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableNamed<T>
extends Named<T>

Immutable implementation of Named.

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

Method Summary

Modifier and Type	Method and Description
String	asHumanReadable() Returns a lazily initialized value of the asHumanReadable attribute.
static <T> ImmutableNamed<T>	copyOf(Named<T> instance) Creates an immutable copy of a Named value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableNamed that have equal attribute values.
int	hashCode() Computes a hash code from attributes: name, type.
protected Optional<String>	name()
static <T> ImmutableNamed<T>	of(Optional<String> name, Class<T> type) Construct a new immutable Named instance.
String	toString() Prints the immutable value Named with attribute values.
protected Class<T>	type()
ImmutableNamed<T>	withName(Optional<String> optional) Copy the current immutable object by setting an optional value for the name attribute.
ImmutableNamed<T>	withName(String value) Copy the current immutable object by setting a present value for the optional name attribute.
ImmutableNamed<T>	withType(Class<T> value) Copy the current immutable object by setting a value for the type attribute.

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

named, ofType

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.formula.Value

relatedTo, unvalidated

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

asHumanReadable

Method Detail

name

protected Optional<String> name()

Specified by:

name in class Named<T>

Returns:

The value of the name attribute

type

protected Class<T> type()

Specified by:

type in class Named<T>

Returns:

The value of the type attribute

withName

public final ImmutableNamed<T> withName(String value)

Copy the current immutable object by setting a present value for the optional name attribute.

Parameters:

value - The value for name

Returns:

A modified copy of this object

withName

public final ImmutableNamed<T> withName(Optional<String> optional)

Copy the current immutable object by setting an optional value for the name attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for name

Returns:

A modified copy of this object

withType

public final ImmutableNamed<T> withType(Class<T> value)

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

Parameters:

value - A new value for type

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableNamed 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: name, type.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Named with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

asHumanReadable

public String asHumanReadable()

Returns a lazily initialized value of the asHumanReadable attribute. Initialized once and only once and stored for subsequent access with proper synchronization. In case of any exception or error thrown by the lazy value initializer, the result will not be memoised (i.e. remembered) and on next call computation will be attempted again.

Specified by:

asHumanReadable in interface HasHumanReadableLabel

Overrides:

asHumanReadable in class Named<T>

Returns:

A lazily initialized value of the asHumanReadable attribute

of

public static <T> ImmutableNamed<T> of(Optional<String> name,
                                       Class<T> type)

Construct a new immutable Named instance.

Type Parameters:

T - generic parameter T

Parameters:

name - The value for the name attribute

type - The value for the type attribute

Returns:

An immutable Named instance

copyOf

public static <T> ImmutableNamed<T> copyOf(Named<T> instance)

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