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

Package | org.flexunit.experimental.theories
Class | public class PotentialAssignment
Inheritance | PotentialAssignment Object
Implements | IPotentialAssignment

A `PotentialAssignment` stores information for a particular value that is assigned to a parameter in a theory method.

Public Properties

| Property | Defined By
--- | --- | ---
|  | name : String The name of the variable that is providing the potential value. | PotentialAssignment
|  | value : Object The value that can be applied to a particular parameter. | PotentialAssignment

Public Methods

| Method | Defined By
--- | --- | ---
|  | PotentialAssignment(name:String, value:Object) Constructor. | PotentialAssignment
|  | forValue(name:String, value:Object):PotentialAssignment [static] Creates a PotentialAssignment for a given name and value. | PotentialAssignment
|  | getDescription():String Returns the name of the variable associated with the PotentialAssignment. | PotentialAssignment
|  | getValue():Object Returns the value of the PotentialAssignment. | PotentialAssignment
|  | toString():String Returns a string that includes the name of the parameter the potential assignment is associated with as well as the value being assigned to the parameter. | PotentialAssignment

Property Detail

name | property

`public var name:String`

The name of the variable that is providing the potential value.

value | property |

`public var value:Object`

The value that can be applied to a particular parameter.

Constructor Detail

PotentialAssignment | () | Constructor

`public function PotentialAssignment(name:String, value:Object)`

Constructor.

Parameters

| `name:String` — The name of the variable that is providing the potential value.
| `value:Object` — The value that can be applied to a particular parameter.

Method Detail

forValue | () | method

`public static function forValue(name:String, value:Object):PotentialAssignment`

Creates a `PotentialAssignment` for a given name and value.

Parameters

| `name:String` — The name of the variable that is providing the potential value.
| `value:Object` — The value that can be applied to a particular parameter.

Returns

| `PotentialAssignment` — a `PotentialAssignment`.

getDescription | () | method |

`public function getDescription():String`

Returns the name of the variable associated with the `PotentialAssignment`.

Returns

| `String`

getValue | () | method |

`public function getValue():Object`

Returns the value of the `PotentialAssignment`.

Returns

| `Object`

toString | () | method |

`public function toString():String`

Returns a string that includes the name of the parameter the potential assignment is associated with as well as the value being assigned to the parameter.

Returns

| `String`

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