de.flapdoodle.reverse.transitions

Class ImmutableJoin<L,R,D>

java.lang.Object

de.flapdoodle.reverse.transitions.Join<L,R,D>

de.flapdoodle.reverse.transitions.ImmutableJoin<L,R,D>

All Implemented Interfaces:

HasLabel, Transition<D>

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableJoin<L,R,D>
extends Join<L,R,D>

Immutable implementation of Join.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableJoin.Builder<L,R,D> Builds instances of type ImmutableJoin.

Nested classes/interfaces inherited from class de.flapdoodle.reverse.transitions.Join

Join.WithDestination<L,R,D>, Join.WithLeft<L>, Join.WithSources<L,R>

Method Summary

Modifier and Type	Method and Description
protected BiFunction<L,R,State<D>>	action()
static <L,R,D> ImmutableJoin.Builder<L,R,D>	builder() Creates a builder for ImmutableJoin.
static <L,R,D> ImmutableJoin<L,R,D>	copyOf(Join<L,R,D> instance) Creates an immutable copy of a Join value.
StateID<D>	destination()
boolean	equals(Object another) This instance is equal to all instances of ImmutableJoin that have equal attribute values.
int	hashCode() Computes a hash code from attributes: left, right, destination, action, transitionLabel.
StateID<L>	left()
StateID<R>	right()
Set<StateID<?>>	sources() Returns a lazily initialized value of the sources attribute.
String	toString() Prints the immutable value Join with attribute values.
String	transitionLabel()
ImmutableJoin<L,R,D>	withAction(BiFunction<L,R,State<D>> value) Copy the current immutable object by setting a value for the action attribute.
ImmutableJoin<L,R,D>	withDestination(StateID<D> value) Copy the current immutable object by setting a value for the destination attribute.
ImmutableJoin<L,R,D>	withLeft(StateID<L> value) Copy the current immutable object by setting a value for the left attribute.
ImmutableJoin<L,R,D>	withRight(StateID<R> value) Copy the current immutable object by setting a value for the right attribute.
ImmutableJoin<L,R,D>	withTransitionLabel(String value) Copy the current immutable object by setting a value for the transitionLabel attribute.

Methods inherited from class de.flapdoodle.reverse.transitions.Join

given, given, of, result

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.reverse.Transition

asLabel

Method Detail

left

public StateID<L> left()

Specified by:

left in class Join<L,R,D>

Returns:

The value of the left attribute

right

public StateID<R> right()

Specified by:

right in class Join<L,R,D>

Returns:

The value of the right attribute

destination

public StateID<D> destination()

Specified by:

destination in interface Transition<D>

Specified by:

destination in class Join<L,R,D>

Returns:

The value of the destination attribute

action

protected BiFunction<L,R,State<D>> action()

Specified by:

action in class Join<L,R,D>

Returns:

The value of the action attribute

transitionLabel

public String transitionLabel()

Specified by:

transitionLabel in interface HasLabel

Overrides:

transitionLabel in class Join<L,R,D>

Returns:

The value of the transitionLabel attribute

withLeft

public final ImmutableJoin<L,R,D> withLeft(StateID<L> value)

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

Parameters:

value - A new value for left

Returns:

A modified copy of the this object

withRight

public final ImmutableJoin<L,R,D> withRight(StateID<R> value)

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

Parameters:

value - A new value for right

Returns:

A modified copy of the this object

withDestination

public final ImmutableJoin<L,R,D> withDestination(StateID<D> value)

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

Parameters:

value - A new value for destination

Returns:

A modified copy of the this object

withAction

public final ImmutableJoin<L,R,D> withAction(BiFunction<L,R,State<D>> value)

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

Parameters:

value - A new value for action

Returns:

A modified copy of the this object

withTransitionLabel

public final ImmutableJoin<L,R,D> withTransitionLabel(String value)

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

Parameters:

value - A new value for transitionLabel

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableJoin 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: left, right, destination, action, transitionLabel.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Join with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

sources

public Set<StateID<?>> sources()

Returns a lazily initialized value of the sources 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:

sources in interface Transition<D>

Overrides:

sources in class Join<L,R,D>

Returns:

A lazily initialized value of the sources attribute

copyOf

public static <L,R,D> ImmutableJoin<L,R,D> copyOf(Join<L,R,D> instance)

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

L - generic parameter L

R - generic parameter R

D - generic parameter D

Parameters:

instance - The instance to copy

Returns:

A copied immutable Join instance

builder

public static <L,R,D> ImmutableJoin.Builder<L,R,D> builder()

Creates a builder for ImmutableJoin.

 ImmutableJoin.<L, R, D>builder()
    .left(de.flapdoodle.reverse.StateID<L>) // required left
    .right(de.flapdoodle.reverse.StateID<R>) // required right
    .destination(de.flapdoodle.reverse.StateID<D>) // required destination
    .action(function.BiFunction<L, R, de.flapdoodle.reverse.State<D>>) // required action
    .transitionLabel(String) // optional transitionLabel
    .build();
 

Type Parameters:

L - generic parameter L

R - generic parameter R

D - generic parameter D

Returns:

A new ImmutableJoin builder