com.github.pnavais.machine.model

Class State

java.lang.Object

com.github.pnavais.machine.api.AbstractNode

com.github.pnavais.machine.model.State

All Implemented Interfaces:

Mergeable<AbstractNode>, Node

Direct Known Subclasses:

AbstractWrappedState

public class State
extends AbstractNode

The default implementation of the state. Contains an optional properties map to store generic state properties as attachments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	State.StateBuilder A basic State builder

Field Summary

Fields inherited from class com.github.pnavais.machine.api.AbstractNode

id, name

Constructor Summary

Constructors

Constructor and Description
State(String name) Constructor with node name

Method Summary

Modifier and Type	Method and Description
State	addProperty(@NonNull String key, @NonNull String value) Adds the property with the given key and value.
boolean	equals(Object o)
static State.StateBuilder	from(String name) Static factory method to create the State
Optional<String>	getProperty(@NonNull String key) Retrieves the property identified by the given key or null if not found
int	hashCode()
boolean	hasProperties() Checks whether the state has properties or not
boolean	hasProperty(@NonNull String key) Checks whether the state contains the given property.
AbstractNode	merge(AbstractNode state) Merges the information of the given state into the current instance.
static State	named(String name) Static factory method to create the State with name.
State	removeProperty(@NonNull String key) Removes the property identified by the given key or discard the operation silently if not found.
String	toString()

Methods inherited from class com.github.pnavais.machine.api.AbstractNode

getId, getName, isFinal, setFinal

Methods inherited from class java.lang.Object

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

Constructor Detail

State

public State(String name)

Constructor with node name

Parameters:

name - the name of the node

Method Detail

from

public static State.StateBuilder from(String name)

Static factory method to create the State

Parameters:

name - the name of the state

Returns:

the state builder

named

public static State named(String name)

Static factory method to create the State with name.

Parameters:

name - the name of the state

Returns:

the state builder

addProperty

public State addProperty(@NonNull
                         @NonNull String key,
                         @NonNull
                         @NonNull String value)

Adds the property with the given key and value.

Parameters:

key - the name of the property to add.

value - the property value

Returns:

self for chaining purposes

removeProperty

public State removeProperty(@NonNull
                            @NonNull String key)

Removes the property identified by the given key or discard the operation silently if not found.

Parameters:

key - the name of the property to remove

Returns:

self for chaining purposes

getProperty

public Optional<String> getProperty(@NonNull
                                    @NonNull String key)

Retrieves the property identified by the given key or null if not found

Parameters:

key - the name of the property to remove

Returns:

the optional property

hasProperty

public boolean hasProperty(@NonNull
                           @NonNull String key)

Checks whether the state contains the given property.

Parameters:

key - the key of the property

Returns:

true if the state has the property, false otherwise

hasProperties

public boolean hasProperties()

Checks whether the state has properties or not

Returns:

true if state has properties, false otherwise

merge

public AbstractNode merge(AbstractNode state)

Merges the information of the given state into the current instance. All incoming properties are added to the current ones potentially overriding existing values.

Specified by:

merge in interface Mergeable<AbstractNode>

Overrides:

merge in class AbstractNode

Parameters:

state - the state to merge

Returns:

the merged state instance

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractNode

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNode

toString

public String toString()

Overrides:

toString in class Object