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

Package | org.flexunit.internals.builders
Class | public class IgnoredClassRunner
Inheritance | IgnoredClassRunner Object
Implements | IRunner

The `IgnoredClassRunner` is an `IRunner` for test classes that are to be ignored. The runner will not run any tests in the provided test class. Instead, it will report that the class has been ignored, providing information about that tests that are present in the ignored testClass.

Public Properties

| Property | Defined By
--- | --- | ---
|  | description : IDescription [read-only] Returns an IDescription of the testClass. | IgnoredClassRunner

Public Methods

| Method | Defined By
--- | --- | ---
|  | IgnoredClassRunner(testClass:Class) Constructor. | IgnoredClassRunner
|  | pleaseStop():void Ask that the tests run stop before starting the next test. | IgnoredClassRunner
|  | run(notifier:IRunNotifier, previousToken:IAsyncTestToken):void Instructs the notifier that a class has been ignored, indiciating how many tests have been ignored in the process. | IgnoredClassRunner

Property Detail

description | property

`description:IDescription` [read-only]

Returns an `IDescription` of the testClass. This `IDescription` is used to provide information about this testClass that can be used in order to determine how many tests have been ignored.

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

IgnoredClassRunner | () | Constructor

`public function IgnoredClassRunner(testClass:Class)`

Constructor. param testClass The class that is to be ignored.

Parameters

| `testClass:Class`

Method Detail

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`

Instructs the `notifier` that a class has been ignored, indiciating how many tests have been ignored in the process. The provided `token` is then notified that the `IgnoredClassRunner` has finished.

Parameters

| `notifier:IRunNotifier` — The `IRunNotifier` to notify that the class has been ignored.
| `previousToken:IAsyncTestToken` — The `AsyncTestToken` to notify that the test class has been ignored.

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