de.flapdoodle.transition.initlike

Class ImmutableState<T>

java.lang.Object

de.flapdoodle.transition.initlike.ImmutableState<T>

All Implemented Interfaces:

State<T>

@Generated(value={"Immutables.generator","State<T>"})
public final class ImmutableState<T>
extends Object
implements State<T>

Immutable implementation of State.

Use the builder to create immutable instances: ImmutableState.<T>builder().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static <T> ImmutableState.Builder<T>	builder(T value) Creates a builder for ImmutableState.
static <T> ImmutableState<T>	copyOf(State<T> instance) Creates an immutable copy of a State value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableState that have equal attribute values.
int	hashCode() Computes a hash code from attributes: value, onTearDown.
Optional<TearDown<T>>	onTearDown()
String	toString() Prints the immutable value State with attribute values.
T	value()
ImmutableState<T>	withOnTearDown(Optional<TearDown<T>> optional) Copy the current immutable object by setting an optional value for the onTearDown attribute.
ImmutableState<T>	withOnTearDown(TearDown<T> value) Copy the current immutable object by setting a present value for the optional onTearDown attribute.
ImmutableState<T>	withValue(T value) Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.transition.initlike.State

merge, of

Method Detail

value

public T value()

Specified by:

value in interface State<T>

Returns:

The value of the value attribute

onTearDown

public Optional<TearDown<T>> onTearDown()

Specified by:

onTearDown in interface State<T>

Returns:

The value of the onTearDown attribute

withValue

public final ImmutableState<T> withValue(T value)

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

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

withOnTearDown

public final ImmutableState<T> withOnTearDown(TearDown<T> value)

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

Parameters:

value - The value for onTearDown

Returns:

A modified copy of this object

withOnTearDown

public final ImmutableState<T> withOnTearDown(Optional<TearDown<T>> optional)

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

Parameters:

optional - A value for onTearDown

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableState 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: value, onTearDown.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value State with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static <T> ImmutableState<T> copyOf(State<T> instance)

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

builder

public static <T> ImmutableState.Builder<T> builder(T value)

Creates a builder for ImmutableState.

Specified by:

builder in interface State<T>

Type Parameters:

T - generic parameter T

Parameters:

value - value parameter

Returns:

A new ImmutableState builder