| Package | org.spicefactory.lib.command |
| Interface | public interface CommandExecutor extends SuspendableCommand, CancellableCommand, AsyncCommand |
| Implementors | AbstractCommandExecutor |
This is the base interface for all command types that group, link or proxy
other commands. Since these commands may implement any of the optional Command
subinterface, this interface introduces properties that determine the capabilities
of this executor.
| Property | Defined By | ||
|---|---|---|---|
 | active : Boolean [read-only]
Indicates whether this command is currently executing. | AsyncCommand | |
| cancellable : Boolean [read-only]
Indicates whether this executor can be cancelled. | CommandExecutor | ||
| suspendable : Boolean [read-only]
Indicates whether this executor can be suspended. | CommandExecutor | ||
| suspended : Boolean [read-only]
Indicates whether this command is currently suspended. | SuspendableCommand | |
| Method | Defined By | ||
|---|---|---|---|
| cancel():void
Cancels the command. | CancellableCommand | |
| execute():void
Executes the command. | Command | |
Method that may be called by frameworks before executing this command to hook
into the lifecycle and data handling of this executor. | CommandExecutor | ||
| resume():void
Resumes the command. | SuspendableCommand | |
| suspend():void
Suspends the command. | SuspendableCommand | |
| cancellable | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescancellable:Boolean [read-only] Indicates whether this executor can be cancelled.
This property should be true when all currently active commands can be cancelled.
public function get cancellable():Boolean| suspendable | property |
suspendable:Boolean [read-only] Indicates whether this executor can be suspended.
This property should be true when all currently active commands can be suspended.
public function get suspendable():Boolean| prepare | () | method |
public function prepare(lifecycle:CommandLifecycle, data:CommandData):voidMethod that may be called by frameworks before executing this command to hook into the lifecycle and data handling of this executor.
Parameters
lifecycle:CommandLifecycle — the lifecycle hooks this executor should use
| |
data:CommandData — data that can be passed to commands executed by this instance
|