public abstract class AbstractFlow extends AbstractFlowStep
Constructor and Description |
---|
AbstractFlow()
No argument constructor to make this flow a Java Bean.
|
AbstractFlow(String name)
Creates this flow from the supplied name.
|
Modifier and Type | Method and Description |
---|---|
void |
addStep(Class<? extends AbstractFlowStep> stepClass)
Adds an instance of the supplied stepClass as a step of this flow.
|
void |
back()
Goes back to the previous startable step.
|
void |
cleanStart()
Cleans data from a previous run and then starts this flow.
|
void |
finish()
Finishes the current step and continues with the next startable step.
|
List<AbstractFlowStep> |
getCurrentFlowPath()
Gets the current flow path.
|
AbstractFlowStep |
getCurrentStep()
Gets the current step.
|
Integer |
getIndexOfCurrentStep()
Gets the index of the current step.
|
Object |
getInputOutputParameter(String key)
Gets the input/output parameter with the supplied key.
|
static List<AbstractFlowStep> |
getLinearListOfFlowSteps(AbstractFlow flow)
Gets a linear list of flow steps.
|
AbstractFlowStep |
getNextStartableStep(int fromIndex)
Recursively gets the next startable step, starting from the supplied fromIndex position.
|
AbstractFlowStep |
getPreviousStartableStep(int fromIndex)
Recursively gets the previous startable step, starting from the supplied fromIndex position.
|
List<AbstractFlowStep> |
getSteps()
Gets all the steps of this flow.
|
boolean |
hasNextStartableStep(int fromIndex)
Recursively determines whether a next startable step exists.
|
boolean |
hasPreviousStartableStep(int fromIndex)
Recursively determines whether a previous startable step exists.
|
Object |
putInputOutputParameter(String key,
Object inputOutputParameter)
Puts the supplied inputOutputParameter in the map of input/output parameters under the supplied key.
|
void |
setIndexOfCurrentStep(Integer indexOfCurrentStep)
Sets the index of the current step.
|
void |
start()
Starts the flow with the first startable step.
|
String |
toString()
Creates a String representation of this AbstractFlow.
|
getName, getParentFlow, getRootFlow, isStartable, isUserStartable, isVisible, setStartable, setUserStartable, setVisible
public AbstractFlow()
public AbstractFlow(String name)
name
- The name of this flow.public AbstractFlowStep getCurrentStep()
public List<AbstractFlowStep> getCurrentFlowPath()
public Integer getIndexOfCurrentStep()
public void setIndexOfCurrentStep(Integer indexOfCurrentStep)
indexOfCurrentStep
- The index of the current step.
IllegalArgumentException
- When the supplied indexOfCurrentStep is out of range.public void addStep(Class<? extends AbstractFlowStep> stepClass)
stepClass
- The class of the step.NullPointerException
- When the supplied stepClass is null.public List<AbstractFlowStep> getSteps()
public static List<AbstractFlowStep> getLinearListOfFlowSteps(AbstractFlow flow)
AbstractFlowStep
so all elements of type AbstractFlow
* are left out.flow
- The flow to create the list from.public Object getInputOutputParameter(String key)
getInputOutputParameter
in class AbstractFlowStep
key
- The key of the input/output parameter.public Object putInputOutputParameter(String key, Object inputOutputParameter)
putInputOutputParameter
in class AbstractFlowStep
key
- The key of the input/output parameter.inputOutputParameter
- The input/output parameter.public void cleanStart()
public void start()
start
in class AbstractFlowStep
public void back()
back
in class AbstractFlowStep
public AbstractFlowStep getPreviousStartableStep(int fromIndex)
fromIndex
- Index position to start searching from.AbstractFlowStep
, not an AbstractFlow
.public void finish()
finish
in class AbstractFlowStep
public AbstractFlowStep getNextStartableStep(int fromIndex)
fromIndex
- Index position to start searching from.AbstractFlowStep
, not an AbstractFlow
.public boolean hasPreviousStartableStep(int fromIndex)
fromIndex
- Index position to start searching from.public boolean hasNextStartableStep(int fromIndex)
fromIndex
- Index position to start searching from.public String toString()
toString
in class AbstractFlowStep
Copyright © 2008–2018. All rights reserved.