io.nflow.engine.workflow.definition

Annotation Type StateVar

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface StateVar

Used for state handler method parameters. Annotated parameters are automatically populated from the workflow instance variables and persisted after processing the state handler method.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The name of the workflow instance variable.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	instantiateIfNotExists Initializes the variable using default constructor (or zero value for primitive types) if the variable does not exist.
boolean	readOnly Makes the variable readonly in the state handler method.

Element Detail

value

public abstract String value

The name of the workflow instance variable.

Returns:

The name of the variable.

readOnly

public abstract boolean readOnly

Makes the variable readonly in the state handler method.

Returns:

True when variable should not be modified, false otherwise.

Default:

false

instantiateIfNotExists

public abstract boolean instantiateIfNotExists

Initializes the variable using default constructor (or zero value for primitive types) if the variable does not exist. Used to ensure that the variable value is never null.

Returns:

True if non-existing variables should be initialized, false otherwise.

Default:

false