| Package | org.spicefactory.lib.command.events |
| Class | public class CommandFailure |
| Inheritance | CommandFailure  Object |
| Property | Defined By | ||
|---|---|---|---|
| cause : Object [read-only]
The cause of the error. | CommandFailure | ||
| executor : CommandExecutor [read-only]
The instance that executed the target command that caused the error. | CommandFailure | ||
| message : String [read-only]
A textual representation of the failure. | CommandFailure | ||
| rootCause : Object [read-only]
The root cause of the error in case of nested commands. | CommandFailure | ||
| target : Object [read-only]
The target command that caused the error. | CommandFailure | ||
| Method | Defined By | ||
|---|---|---|---|
CommandFailure(executor:CommandExecutor, target:Object, cause:Object)
Creates a new instance. | CommandFailure | ||
| cause | property |
cause:Object [read-only]
The cause of the error.
Usually an instance of Error, ErrorEvent
or CommandTimeout, but may be any type like a simple String.
public function get cause():Object| executor | property |
executor:CommandExecutor [read-only] The instance that executed the target command that caused the error.
public function get executor():CommandExecutor| message | property |
message:String [read-only] A textual representation of the failure.
public function get message():String| rootCause | property |
rootCause:Object [read-only]
The root cause of the error in case of nested commands.
When executing a command sequence or flow the individual
commands might themselves be sequences or flows. In this
case the cause property may hold another
instance of CommandFailure. This property
always returns the root cause as produced by the actual
target command.
public function get rootCause():Object| target | property |
target:Object [read-only] The target command that caused the error.
public function get target():Object| CommandFailure | () | Constructor |
public function CommandFailure(executor:CommandExecutor, target:Object, cause:Object)Creates a new instance.
Parametersexecutor:CommandExecutor — the instance that executed the target command that caused the error
| |
target:Object — the target command that caused the error
| |
cause:Object — the cause of the error
|