de.flapdoodle.formula.values

Class ImmutableAttribute<O,T>

java.lang.Object

de.flapdoodle.formula.values.Attribute<O,T>

de.flapdoodle.formula.values.ImmutableAttribute<O,T>

All Implemented Interfaces:

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

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

Immutable implementation of Attribute.

Use the builder to create immutable instances: ImmutableAttribute.builder().

Nested Class Summary

Nested Classes

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

Method Summary

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

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

get, isMatchingInstance, of, set, toString

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

Method Detail

objectType

protected Class<O> objectType()

Specified by:

objectType in class Attribute<O,T>

Returns:

The value of the objectType attribute

name

protected String name()

Specified by:

name in class Attribute<O,T>

Returns:

The value of the name attribute

getter

protected Function<O,T> getter()

Specified by:

getter in class Attribute<O,T>

Returns:

The value of the getter attribute

setter

protected BiConsumer<O,T> setter()

Specified by:

setter in class Attribute<O,T>

Returns:

The value of the setter attribute

withObjectType

public final ImmutableAttribute<O,T> withObjectType(Class<O> value)

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

Parameters:

value - A new value for objectType

Returns:

A modified copy of the this object

withName

public final ImmutableAttribute<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 ImmutableAttribute<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

withSetter

public final ImmutableAttribute<O,T> withSetter(BiConsumer<O,T> value)

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

Parameters:

value - A new value for setter

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

copyOf

public static <O,T> ImmutableAttribute<O,T> copyOf(Attribute<O,T> instance)

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

builder

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

Creates a builder for ImmutableAttribute.

 ImmutableAttribute.<O, T>builder()
    .objectType(Class<O>) // required objectType
    .name(String) // required name
    .getter(function.Function<O, T>) // required getter
    .setter(function.BiConsumer<O, T>) // required setter
    .build();
 

Type Parameters:

O - generic parameter O

T - generic parameter T

Returns:

A new ImmutableAttribute builder