de.flapdoodle.formula.values.properties

Class ImmutableReadOnlyProperty<O,T>

java.lang.Object

de.flapdoodle.formula.values.properties.ReadOnlyProperty<O,T>

de.flapdoodle.formula.values.properties.ImmutableReadOnlyProperty<O,T>

All Implemented Interfaces:

HasHumanReadableLabel, IsReadable<O,T>

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

Immutable implementation of ReadOnlyProperty.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static <O,T> ImmutableReadOnlyProperty.Builder<O,T>	builder() Creates a builder for ImmutableReadOnlyProperty.
static <O,T> ImmutableReadOnlyProperty<O,T>	copyOf(ReadOnlyProperty<O,T> instance) Creates an immutable copy of a ReadOnlyProperty value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableReadOnlyProperty that have equal attribute values.
protected Function<O,T>	getter()
int	hashCode() Computes a hash code from attributes: type, name, getter.
protected String	name()
static <O,T> ImmutableReadOnlyProperty<O,T>	of(Class<O> type, String name, Function<O,T> getter) Construct a new immutable ReadOnlyProperty instance.
protected Class<O>	type()
ImmutableReadOnlyProperty<O,T>	withGetter(Function<O,T> value) Copy the current immutable object by setting a value for the getter attribute.
ImmutableReadOnlyProperty<O,T>	withName(String value) Copy the current immutable object by setting a value for the name attribute.
ImmutableReadOnlyProperty<O,T>	withType(Class<O> value) Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class de.flapdoodle.formula.values.properties.ReadOnlyProperty

asHumanReadable, get, toString, withId

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

type

protected Class<O> type()

Specified by:

type in class ReadOnlyProperty<O,T>

Returns:

The value of the type attribute

name

protected String name()

Specified by:

name in class ReadOnlyProperty<O,T>

Returns:

The value of the name attribute

getter

protected Function<O,T> getter()

Specified by:

getter in class ReadOnlyProperty<O,T>

Returns:

The value of the getter attribute

withType

public final ImmutableReadOnlyProperty<O,T> withType(Class<O> 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

withName

public final ImmutableReadOnlyProperty<O,T> withName(String value)

Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withGetter

public final ImmutableReadOnlyProperty<O,T> withGetter(Function<O,T> value)

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

Parameters:

value - A new value for getter

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

of

public static <O,T> ImmutableReadOnlyProperty<O,T> of(Class<O> type,
                                                      String name,
                                                      Function<O,T> getter)

Construct a new immutable ReadOnlyProperty instance.

Type Parameters:

O - generic parameter O

T - generic parameter T

Parameters:

type - The value for the type attribute

name - The value for the name attribute

getter - The value for the getter attribute

Returns:

An immutable ReadOnlyProperty instance

copyOf

public static <O,T> ImmutableReadOnlyProperty<O,T> copyOf(ReadOnlyProperty<O,T> instance)

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

builder

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

Creates a builder for ImmutableReadOnlyProperty.

 ImmutableReadOnlyProperty.<O, T>builder()
    .type(Class<O>) // required type
    .name(String) // required name
    .getter(function.Function<O, T>) // required getter
    .build();
 

Type Parameters:

O - generic parameter O

T - generic parameter T

Returns:

A new ImmutableReadOnlyProperty builder