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

Package | org.flexunit.runner
Interface | public interface IDescription
Implementors | Description

An `IDescription` class that is being used in a test run. An `IDescription` can be atomic (a single test) or compound (containing children tests). `IDescription`s are used to provide feedback about the tests that are about to run (for example, the tree view visible in many IDEs) or tests that have been run (for example, the failures view). This information can be used to report the current progress of the test run.

Public Properties

| Property | Defined By
--- | --- | ---
|  | children : Array [read-only] | IDescription
|  | displayName : String [read-only] | IDescription
|  | isEmpty : Boolean [read-only] | IDescription
|  | isInstance : Boolean [read-only] | IDescription
|  | isSuite : Boolean [read-only] | IDescription
|  | isTest : Boolean [read-only] | IDescription
|  | testCount : int [read-only] | IDescription

Public Methods

| Method | Defined By
--- | --- | ---
|  | addChild(description:IDescription):void Adds an IDescription as a child of the receiver. | IDescription
|  | childlessCopy():IDescription Returns a copy of this description, with no children (on the assumption that some of the children will be added back). | IDescription
|  | equals(obj:Object):Boolean Determines if the current description is equal to the provided obj. | IDescription
|  | getAllMetadata():Array Returns all of the metadata that is attached to this description node. | IDescription

Property Detail

children | property

`children:Array` [read-only]

Implementation
`public function get children():Array`

displayName | property |

`displayName:String` [read-only]

Implementation
`public function get displayName():String`

isEmpty | property |

`isEmpty:Boolean` [read-only]

Implementation
`public function get isEmpty():Boolean`

isInstance | property |

`isInstance:Boolean` [read-only]

Implementation
`public function get isInstance():Boolean`

isSuite | property |

`isSuite:Boolean` [read-only]

Implementation
`public function get isSuite():Boolean`

isTest | property |

`isTest:Boolean` [read-only]

Implementation
`public function get isTest():Boolean`

testCount | property |

`testCount:int` [read-only]

Implementation
`public function get testCount():int`
Method Detail

addChild | () | method

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

Adds an `IDescription` as a child of the receiver.

Parameters

| `description:IDescription` — the soon-to-be child.

childlessCopy | () | method |

`public function childlessCopy():IDescription`

Returns a copy of this description, with no children (on the assumption that some of the children will be added back).

Returns

| `IDescription` — a copy of this description, with no children (on the assumption that some of the children will be added back).

equals | () | method |

`public function equals(obj:Object):Boolean`

Determines if the current description is equal to the provided `obj`.

Parameters

| `obj:Object` — The object to check against the current description.

Returns

| `Boolean` — true if this is a description of a Runner that runs no tests

getAllMetadata | () | method |

`public function getAllMetadata():Array`

Returns all of the metadata that is attached to this description node.

Returns

| `Array` — the metadata as XML that is attached to this description node, or null if none exists

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