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

Package | org.flexunit.runner.notification
Interface | public interface IRunListener
Implementors | RunListener

The `IRunListener` is an interface used be classes that want to act as a run listener, responding to events that occur during a test run. If the `IRunListener` is registered to an `IRunNotifier` it will be notified of the following eventts:

- A test run has started
- A test run has finished
- A test has started
- A test has finished
- A test has failed
- A test has violated an assumption
- A test has been ignored

While there is generally only one `IRunNotifier` present in the system at any given time, there can be multiple `IRunListener`s. `IRunListener`s listen to these messages from the `IRunNotifier` and optionally perform some action. Examples of some `IRunNotifier`s built into FlexUnit4 include the `TraceListener` and `TextListener`.

See also

org.flexunit.internals.TraceListener
org.flexunit.internals.TextListener

Public Methods

| Method | Defined By
--- | --- | ---
|  | testAssumptionFailure(failure:Failure):void Called when an atomic test flags that it assumes a condition that is false. | IRunListener
|  | testFailure(failure:Failure):void Called when an atomic test fails. | IRunListener
|  | testFinished(description:IDescription):void Called when an atomic test has finished, whether the test succeeds or fails. | IRunListener
|  | testIgnored(description:IDescription):void Called when a test will not be run, generally because a test method is annotated with the Ignore tag. | IRunListener
|  | testRunFinished(result:Result):void Called when all tests have finished and the test run is done. | IRunListener
|  | testRunStarted(description:IDescription):void Called before any tests have been run and the test run is starting. | IRunListener
|  | testStarted(description:IDescription):void Called when an atomic test is about to be begin. | IRunListener

Method Detail

testAssumptionFailure | () | method

`public function testAssumptionFailure(failure:Failure):void`

Called when an atomic test flags that it assumes a condition that is false.

Parameters

| `failure:Failure` — The `Failure` indicating the `AssumptionViolatedException` that was thrown.

testFailure | () | method |

`public function testFailure(failure:Failure):void`

Called when an atomic test fails.

Parameters

| `failure:Failure` — The `Failure` indicating why the test has failed.

testFinished | () | method |

`public function testFinished(description:IDescription):void`

Called when an atomic test has finished, whether the test succeeds or fails.

Parameters

| `description:IDescription` — The `IDescription` of the test that finished.

testIgnored | () | method |

`public function testIgnored(description:IDescription):void`

Called when a test will not be run, generally because a test method is annotated with the `Ignore` tag.

Parameters

| `description:IDescription` — The `IDescription` of the test that will be ignored.

testRunFinished | () | method |

`public function testRunFinished(result:Result):void`

Called when all tests have finished and the test run is done.

Parameters

| `result:Result` — The `Result` of the test run, including all the tests that have failed.

testRunStarted | () | method |

`public function testRunStarted(description:IDescription):void`

Called before any tests have been run and the test run is starting.

Parameters

| `description:IDescription` — The `IDescription` of the top most `IRunner`.

testStarted | () | method |

`public function testStarted(description:IDescription):void`

Called when an atomic test is about to be begin.

Parameters

| `description:IDescription` — The `IDescription` of the test that is about to be run (generally a class and method name).

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