| Package | com.whirled.contrib.avrg.probe |
| Class | public class Parameter |
| Subclasses | ArrayParameter, CallbackParameter, ObjectParameter, PointParameter, RectangleParameter |
| Property | Defined by | ||
|---|---|---|---|
| name : String [read-only]
The name of the parameter.
| Parameter | ||
| nullable : Boolean [read-only]
Whether null may be passed for this parameter's value.
| Parameter | ||
| optional : Boolean [read-only]
Whether this parameter may be omitted when calling the function.
| Parameter | ||
| type : Class [read-only]
The type of the parameter.
| Parameter | ||
| typeDisplay : String [read-only]
A concise string representing the type of the parameter for user interfaces.
| Parameter | ||
| Property | Defined by | ||
|---|---|---|---|
| _flags : uint | Parameter | ||
| _name : String | Parameter | ||
| _type : Class | Parameter | ||
| Method | Defined by | ||
|---|---|---|---|
|
Parameter(name:String, type:Class, flags:uint = 0)
Creates a new parameter.
| Parameter | ||
|
isAlpha(char:String):Boolean
[static]
Tests if a character is alphabetic.
| Parameter | ||
|
isDigit(char:String):Boolean
[static]
Tests if a character is a digit.
| Parameter | ||
|
parse(input:String):Object
Translates a string to an object of this parameter's type.
| Parameter | ||
| Constant | Defined by | ||
|---|---|---|---|
| NULLABLE : int = 2 [static] Flag value for parameters that may take null.
| Parameter | ||
| OPTIONAL : int = 1 [static] Flag value for parameters that are optional.
| Parameter | ||
| _flags | property |
protected var _flags:uint
| _name | property |
protected var _name:String
| name | property |
name:String [read-only]The name of the parameter.
Implementation public function get name():String
| nullable | property |
nullable:Boolean [read-only]Whether null may be passed for this parameter's value.
Implementation public function get nullable():Boolean
| optional | property |
optional:Boolean [read-only]Whether this parameter may be omitted when calling the function.
Implementation public function get optional():Boolean
| _type | property |
protected var _type:Class
| type | property |
type:Class [read-only]The type of the parameter.
Implementation public function get type():Class
| typeDisplay | property |
typeDisplay:String [read-only]A concise string representing the type of the parameter for user interfaces.
Implementation public function get typeDisplay():String
| Parameter | () | constructor |
public function Parameter(name:String, type:Class, flags:uint = 0)Creates a new parameter.
Parametersname:String — the name of the parameter
|
|
type:Class — the type of the parameter
|
|
flags:uint (default = 0) — one or more flag values or'ed together
|
See also
| isAlpha | () | method |
public static function isAlpha(char:String):BooleanTests if a character is alphabetic.
Parameterschar:String |
Boolean |
| isDigit | () | method |
public static function isDigit(char:String):BooleanTests if a character is a digit.
Parameterschar:String |
Boolean |
| parse | () | method |
public function parse(input:String):ObjectTranslates a string to an object of this parameter's type.
Parametersinput:String |
Object |
— if the string could not be translated
|
| NULLABLE | constant |
public static const NULLABLE:int = 2Flag value for parameters that may take null.
| OPTIONAL | constant |
public static const OPTIONAL:int = 1Flag value for parameters that are optional.