io.datafx.controller.flow.action

Class AbstractFlowTaskAction

java.lang.Object

io.datafx.controller.flow.action.AbstractFlowTaskAction

All Implemented Interfaces:

FlowAction

Direct Known Subclasses:

FlowAsyncTaskAction, FlowTaskAction

public abstract class AbstractFlowTaskAction
extends java.lang.Object
implements FlowAction

Basic class for FlowAction implementations that execute a custom task. In this case a task is always defined as a Runnable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractFlowTaskAction.TaskFactory

Constructor Summary

Constructors

Constructor and Description
AbstractFlowTaskAction(java.lang.Class<? extends java.lang.Runnable> runnableClass) Defines a new AbstractFlowTaskAction instance that task is defined by a class that extends Runnable.
AbstractFlowTaskAction(java.lang.Runnable runnable) Defines a new AbstractFlowTaskAction instance that task is defined by a Runnable instance.

Method Summary

Modifier and Type	Method and Description
protected abstract void	execute(java.lang.Runnable r) Executes the defined Runnable
void	handle(FlowHandler flowHandler, java.lang.String actionId) This method will be called by the FlowHandler of the current flow whenever the action is triggered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFlowTaskAction

public AbstractFlowTaskAction(java.lang.Class<? extends java.lang.Runnable> runnableClass)

Defines a new AbstractFlowTaskAction instance that task is defined by a class that extends Runnable. Whenever a action is triggered a new instance of the given class will be created. Therefore the class needs a default constructor. All injection that is working in a controller class will work in the given class that defines the task, too.

Parameters:

runnableClass - the class that defines the task

AbstractFlowTaskAction

public AbstractFlowTaskAction(java.lang.Runnable runnable)

Defines a new AbstractFlowTaskAction instance that task is defined by a Runnable instance.

Parameters:

runnable - defines the task and will be called whenever the action is triggered.

Method Detail

handle

public void handle(FlowHandler flowHandler,
                   java.lang.String actionId)
            throws FlowException

Description copied from interface: FlowAction

This method will be called by the FlowHandler of the current flow whenever the action is triggered.

Specified by:

handle in interface FlowAction

Parameters:

flowHandler - the flowHandler of the current flow

actionId - unique ID of this action in the current flow

Throws:

FlowException - if an error occures while handling the action

execute

protected abstract void execute(java.lang.Runnable r)
                         throws java.lang.Exception

Executes the defined Runnable

Parameters:

r - the runnable

Throws:

java.lang.Exception - if the runnable can't be executed