Packagecom.whirled.contrib.avrg.probe
Classpublic class Parameter
SubclassesArrayParameter, CallbackParameter, ObjectParameter, PointParameter, RectangleParameter

Represents a named, typed parameter to an action script function. Basic types are handled: String, int, Number, Boolean. Other types are handled by subclasses.



Public Properties
 PropertyDefined 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
Protected Properties
 PropertyDefined by
  _flags : uint
Parameter
  _name : String
Parameter
  _type : Class
Parameter
Public Methods
 MethodDefined 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
Public Constants
 ConstantDefined 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
Property detail
_flagsproperty
protected var _flags:uint
_nameproperty 
protected var _name:String
nameproperty 
name:String  [read-only]

The name of the parameter.

Implementation
    public function get name():String
nullableproperty 
nullable:Boolean  [read-only]

Whether null may be passed for this parameter's value.

Implementation
    public function get nullable():Boolean
optionalproperty 
optional:Boolean  [read-only]

Whether this parameter may be omitted when calling the function.

Implementation
    public function get optional():Boolean
_typeproperty 
protected var _type:Class
typeproperty 
type:Class  [read-only]

The type of the parameter.

Implementation
    public function get type():Class
typeDisplayproperty 
typeDisplay:String  [read-only]

A concise string representing the type of the parameter for user interfaces.

Implementation
    public function get typeDisplay():String
Constructor detail
Parameter()constructor
public function Parameter(name:String, type:Class, flags:uint = 0)

Creates a new parameter.

Parameters
name: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

Method detail
isAlpha()method
public static function isAlpha(char:String):Boolean

Tests if a character is alphabetic.

Parameters
char:String

Returns
Boolean
isDigit()method 
public static function isDigit(char:String):Boolean

Tests if a character is a digit.

Parameters
char:String

Returns
Boolean
parse()method 
public function parse(input:String):Object

Translates a string to an object of this parameter's type.

Parameters
input:String

Returns
Object

Throws
— if the string could not be translated
Constant detail
NULLABLEconstant
public static const NULLABLE:int = 2

Flag value for parameters that may take null.

OPTIONALconstant 
public static const OPTIONAL:int = 1

Flag value for parameters that are optional.