ImmutableDerive (Flapdoodle Reverse 1.7.2 API)

java.lang.Object
- de.flapdoodle.reverse.transitions.Derive<S,D>
- - de.flapdoodle.reverse.transitions.ImmutableDerive<S,D>

All Implemented Interfaces:

HasLabel, Transition<D>
```
@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableDerive<S,D>
extends Derive<S,D>
```
Immutable implementation of Derive.
Use the builder to create immutable instances: ImmutableDerive.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableDerive.Builder<S,D>
Builds instances of type ImmutableDerive.
- Nested classes/interfaces inherited from class de.flapdoodle.reverse.transitions.Derive
  Derive.WithSource<S>, Derive.WithSourceAndDestination<S,D>

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableDerive.Builder<S,D>` Builds instances of type `ImmutableDerive`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Function<S,State<D>>`	`action()`
`static <S,D> ImmutableDerive.Builder<S,D>`	`builder()` Creates a builder for `ImmutableDerive`.
`static <S,D> ImmutableDerive<S,D>`	`copyOf(Derive<S,D> instance)` Creates an immutable copy of a `Derive` value.
`StateID<D>`	`destination()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableDerive` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `source`, `destination`, `action`, `transitionLabel`.
`StateID<S>`	`source()`
`Set<StateID<?>>`	`sources()` Returns a lazily initialized value of the `sources` attribute.
`String`	`toString()` Prints the immutable value `Derive` with attribute values.
`String`	`transitionLabel()`
`ImmutableDerive<S,D>`	`withAction(Function<S,State<D>> value)` Copy the current immutable object by setting a value for the `action` attribute.
`ImmutableDerive<S,D>`	`withDestination(StateID<D> value)` Copy the current immutable object by setting a value for the `destination` attribute.
`ImmutableDerive<S,D>`	`withSource(StateID<S> value)` Copy the current immutable object by setting a value for the `source` attribute.
`ImmutableDerive<S,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.Derive
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
  - source
```
public StateID<S> source()
```
    Specified by:
    
    source in class Derive<S,D>
    
    Returns:
    
    The value of the source attribute
  - destination
```
public StateID<D> destination()
```
    Specified by:
    
    destination in interface Transition<D>
    
    Specified by:
    
    destination in class Derive<S,D>
    
    Returns:
    
    The value of the destination attribute
  - action
```
protected Function<S,State<D>> action()
```
    Specified by:
    
    action in class Derive<S,D>
    
    Returns:
    
    The value of the action attribute
  - transitionLabel
```
public String transitionLabel()
```
    Specified by:
    
    transitionLabel in interface HasLabel
    
    Overrides:
    
    transitionLabel in class Derive<S,D>
    
    Returns:
    
    The value of the transitionLabel attribute
  - withSource
```
public final ImmutableDerive<S,D> withSource(StateID<S> value)
```
    Copy the current immutable object by setting a value for the source attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for source
    
    Returns:
    
    A modified copy of the this object
  - withDestination
```
public final ImmutableDerive<S,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 ImmutableDerive<S,D> withAction(Function<S,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 ImmutableDerive<S,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 ImmutableDerive 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: source, destination, action, transitionLabel.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value Derive 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 Derive<S,D>
    
    Returns:
    
    A lazily initialized value of the sources attribute
  - copyOf
```
public static <S,D> ImmutableDerive<S,D> copyOf(Derive<S,D> instance)
```
    Creates an immutable copy of a Derive 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:
    
    S - generic parameter S
    
    D - generic parameter D
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable Derive instance
  - builder
```
public static <S,D> ImmutableDerive.Builder<S,D> builder()
```
    Creates a builder for ImmutableDerive.
```
 ImmutableDerive.&lt;S, D&gt;builder()
    .source(de.flapdoodle.reverse.StateID&lt;S&gt;) // required source
    .destination(de.flapdoodle.reverse.StateID&lt;D&gt;) // required destination
    .action(function.Function&lt;S, de.flapdoodle.reverse.State&lt;D&gt;&gt;) // required action
    .transitionLabel(String) // optional transitionLabel
    .build();
 
```
    Type Parameters:
    
    S - generic parameter S
    
    D - generic parameter D
    
    Returns:
    
    A new ImmutableDerive builder

Class ImmutableDerive<S,D>

Nested Class Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface de.flapdoodle.reverse.Transition

Method Detail

source

destination

action

transitionLabel

withSource

withDestination

withAction

withTransitionLabel

equals

hashCode

toString

sources

copyOf

builder