com.whizzosoftware.hobson.api.action

Class CompositeAction

java.lang.Object

com.whizzosoftware.hobson.api.action.CompositeAction

All Implemented Interfaces:

Action

public class CompositeAction
extends java.lang.Object
implements Action

Represents an action comprised of other actions. The action is considered complete when all its sub-actions are.

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
CompositeAction(java.util.List<Action> actions) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isAssociatedWithPlugin(PluginContext ctx) Indicates whether this action is associated with a particular plugin.
Future	sendMessage(ActionLifecycleContext ctx, java.lang.String msgName, java.lang.Object prop) Sends a message to the action.
Future	start(ActionLifecycleContext ctx) Starts the action.
Future	stop(ActionLifecycleContext ctx) Stops the action.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeAction

public CompositeAction(java.util.List<Action> actions)

Constructor.

Parameters:

actions - a list of actions that comprise the composite action

Method Detail

isAssociatedWithPlugin

public boolean isAssociatedWithPlugin(PluginContext ctx)

Description copied from interface: Action

Indicates whether this action is associated with a particular plugin.

Specified by:

isAssociatedWithPlugin in interface Action

Parameters:

ctx - the plugin context

Returns:

a boolean

sendMessage

public Future sendMessage(ActionLifecycleContext ctx,
                          java.lang.String msgName,
                          java.lang.Object prop)

Description copied from interface: Action

Sends a message to the action.

Specified by:

sendMessage in interface Action

Parameters:

ctx - the lifecycle context

msgName - the name of the message

prop - a property object

Returns:

a Future

start

public Future start(ActionLifecycleContext ctx)

Description copied from interface: Action

Starts the action.

Specified by:

start in interface Action

Parameters:

ctx - the lifecycle context

Returns:

a Future

stop

public Future stop(ActionLifecycleContext ctx)

Description copied from interface: Action

Stops the action.

Specified by:

stop in interface Action

Parameters:

ctx - the lifecycle context

Returns:

a Future