API Documentation | All Packages | All Classes | Index | Frames No Frames |
SequenceRunner

Package | org.fluint.sequence
Class | public class SequenceRunner
Inheritance | SequenceRunner Object

Allows developer to add a series of steps, execute those steps in order, until the sequence is complete.

Public Properties

| Property | Defined By
--- | --- | ---
|  | numberOfSteps : int [read-only] Returns number of steps in the sequence. | SequenceRunner

Public Methods

| Method | Defined By
--- | --- | ---
|  | SequenceRunner(testCase:*) Constructor. | SequenceRunner
|  | addAssertHandler(assertHandler:Function, passThroughData:Object):void Add a reference to the event handler that should be called if the sequence completes sucessfully. The handler is expected to have the follow signature: public function handleEvent( event:Event, passThroughData:Object ):void { } | SequenceRunner
|  | addStep(step:ISequenceStep):void Adds an ISequenceStep to the sequence. | SequenceRunner
|  | continueSequence(event:Event):void Called by the testCase when the next step in the sequence should begin. | SequenceRunner
|  | getExecutingStep():ISequenceStep Returns the ISequenceStep currently executing. | SequenceRunner
|  | getPendingStep():ISequencePend Returns the ISequenceStep currently executing. | SequenceRunner
|  | getStep(stepIndex:int):ISequenceStep Returns the ISequenceStep at a specified index. | SequenceRunner
|  | run():void Begins the execution of a sequence. | SequenceRunner

Property Detail

numberOfSteps | property

`numberOfSteps:int` [read-only]

Returns number of steps in the sequence.

Implementation
`public function get numberOfSteps():int`
Constructor Detail

SequenceRunner | () | Constructor

`public function SequenceRunner(testCase:*)`

Constructor.

Parameters

| `testCase:*` — testCase within which is sequence is being run.

Method Detail

addAssertHandler | () | method

`public function addAssertHandler(assertHandler:Function, passThroughData:Object):void`

Add a reference to the event handler that should be called if the sequence completes sucessfully.

The handler is expected to have the follow signature:

`public function handleEvent( event:Event, passThroughData:Object ):void { }`

Parameters

| `assertHandler:Function` — The original event object from the previous step.
| `passThroughData:Object` — A generic object that can optionally be provided by the developer when creating a new sequence.

addStep | () | method |

`public function addStep(step:ISequenceStep):void`

Adds an ISequenceStep to the sequence.

Parameters

| `step:ISequenceStep` — Step to be added.

continueSequence | () | method |

`public function continueSequence(event:Event):void`

Called by the testCase when the next step in the sequence should begin.

Parameters

| `event:Event` — Event broadcast by the last step in the sequence.

getExecutingStep | () | method |

`public function getExecutingStep():ISequenceStep`

Returns the ISequenceStep currently executing.

Returns

| `ISequenceStep`

getPendingStep | () | method |

`public function getPendingStep():ISequencePend`

Returns the ISequenceStep currently executing.

Returns

| `ISequencePend`

getStep | () | method |

`public function getStep(stepIndex:int):ISequenceStep`

Returns the ISequenceStep at a specified index.

Parameters

| `stepIndex:int`

Returns

| `ISequenceStep`

run | () | method |

`public function run():void`

Begins the execution of a sequence.

Thu Apr 10 2014, 08:07 AM +10:00