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

Package | org.flexunit.internals.runners
Class | public class FlexUnit1ClassRunner
Inheritance | FlexUnit1ClassRunner Object
Implements | IRunner, IFilterable
Subclasses | SuiteMethod

The `FlexUnit1ClassRunner` is responsible for running FlexUnit1 classes.

Public Properties

| Property | Defined By
--- | --- | ---
|  | description : IDescription [read-only] Returns an IDescription of the test class that the runner is running. | FlexUnit1ClassRunner

Public Methods

| Method | Defined By
--- | --- | ---
|  | FlexUnit1ClassRunner(klassOrTest:*) Constructor. | FlexUnit1ClassRunner
|  | createAdaptingListener(notifier:IRunNotifier, token:AsyncTestToken):TestListener [static] Creates a TestListener using a provided notifier and token. | FlexUnit1ClassRunner
|  | filter(filter:IFilter):void Will apply a Filter to the test object. | FlexUnit1ClassRunner
|  | getClassFromTest(test:Test):Class [static] Returns the Class for a provided Test. | FlexUnit1ClassRunner
|  | pleaseStop():void Ask that the tests run stop before starting the next test. | FlexUnit1ClassRunner
|  | run(notifier:IRunNotifier, previousToken:IAsyncTestToken):void Runs the test class and updates the notifier on the status of running the tests. | FlexUnit1ClassRunner

Protected Methods

| Method | Defined By
--- | --- | ---
|  | describeChild(child:*):IDescription Returns an IDescription for child. | FlexUnit1ClassRunner
|  | handleTestComplete(result:ChildResult):void Handles the results of a single test completing. | FlexUnit1ClassRunner

Property Detail

description | property

`description:IDescription` [read-only]

Returns an `IDescription` of the test class that the runner is running.

Implementation
`public function get description():IDescription`
Constructor Detail

FlexUnit1ClassRunner | () | Constructor

`public function FlexUnit1ClassRunner(klassOrTest:*)`

Constructor.

Parameters

| `klassOrTest:*` — The class or test to run.

Method Detail

createAdaptingListener | () | method

`public static function createAdaptingListener(notifier:IRunNotifier, token:AsyncTestToken):TestListener`

Creates a `TestListener` using a provided `notifier` and `token`.

Parameters

| `notifier:IRunNotifier` — The notifier to notify about the status of the test.
| `token:AsyncTestToken` — The token to nofity when the test has finished.

Returns

| `TestListener` — a `TestListener`.

describeChild | () | method |

`protected function describeChild(child:*):IDescription`

Returns an `IDescription` for `child`.

Parameters

| `child:*` — The child to describe.

Returns

| `IDescription` — an `IDescription` of the provided `child`.

filter | () | method |

`public function filter(filter:IFilter):void`

Will apply a `Filter` to the test object.

Parameters

| `filter:IFilter` — Filter

See also

org.flexunit.runner.manipulation.Filter

getClassFromTest | () | method |

`public static function getClassFromTest(test:Test):Class`

Returns the `Class` for a provided `Test`.

Parameters

| `test:Test` — The `Test` for which to obtain the `Class`.

Returns

| `Class` — the `Class` for a provided `Test`.

handleTestComplete | () | method |

`protected function handleTestComplete(result:ChildResult):void`

Handles the results of a single test completing.

Parameters

| `result:ChildResult` — The results of the running test.

pleaseStop | () | method |

`public function pleaseStop():void`

Ask that the tests run stop before starting the next test. Phrased politely because the test currently running will not be interrupted.

run | () | method |

`public function run(notifier:IRunNotifier, previousToken:IAsyncTestToken):void`

Runs the test class and updates the `notifier` on the status of running the tests.

Parameters

| `notifier:IRunNotifier` — The notifier that is notified about issues encountered during the execution of the test class.
| `previousToken:IAsyncTestToken` — The token that is to be notified when the runner has finished execution of the test class.

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