Packagecom.whirled.contrib.avrg.probe
Classpublic class ArrayParameter
InheritanceArrayParameter Inheritance Parameter

Parameter type used when an array is expected. Parses a simple sequence of values in brackets such as [1,2,3] or ["1", "2", "3"]. Commas within items like ["0,2"] will not work.



Public Properties
 PropertyDefined by
 Inheritedname : String
The name of the parameter.
Parameter
 Inheritednullable : Boolean
Whether null may be passed for this parameter's value.
Parameter
 Inheritedoptional : Boolean
Whether this parameter may be omitted when calling the function.
Parameter
  type : Class
[read-only] The type of the parameter.
ArrayParameter
  typeDisplay : String
[read-only] A concise string representing the type of the parameter for user interfaces.
ArrayParameter
Protected Properties
 PropertyDefined by
 Inherited_flags : uint
Parameter
 Inherited_name : String
Parameter
 Inherited_type : Class
Parameter
Public Methods
 MethodDefined by
  
ArrayParameter(name:String, type:Class, flags:uint = 0)
Creates a new array parameter.
ArrayParameter
 Inherited
isAlpha(char:String):Boolean
[static] Tests if a character is alphabetic.
Parameter
 Inherited
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.
ArrayParameter
Public Constants
 ConstantDefined by
 InheritedNULLABLE : int = 2
[static] Flag value for parameters that may take null.
Parameter
 InheritedOPTIONAL : int = 1
[static] Flag value for parameters that are optional.
Parameter
Property detail
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
ArrayParameter()constructor
public function ArrayParameter(name:String, type:Class, flags:uint = 0)

Creates a new array parameter.

Parameters
name:String — the name of the parameter
 
type:Class — the type to use when parsing the values between commas
 
flags:uint (default = 0) — optional values passed to superclass
Method detail
parse()method
public override function parse(input:String):Object

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

Parameters
input:String

Returns
Object