Objeck Classes

All Bundles

ParameterType

Function parameter type definition

Implements: Compare

Operations

New
Compare
GetDesc
GetName
GetProps
GetType
HashID
ToJson
ToString

New

Constructor

New(name:String, type:ParameterType->Type)

Parameters

Name	Type	Description
name	String	function parameter name
type	ParameterType->Type	parameter type

Constructor

New(name:String, type:ParameterType->Type, desc:String)

Parameters

Name	Type	Description
name	String	function parameter name
type	ParameterType->Type	parameter type
desc	String	description

Constructor

New(name:String, props:Set<ParameterType>)

Parameters

Name	Type	Description
name	String	function parameter name
props	Set<ParameterType>	set of named parameter properties

Constructor

New(name:String, props:Set<ParameterType>, req_params:String[])

Parameters

Name	Type	Description
name	String	function parameter name
props	Set<ParameterType>	set of named parameter properties
req_params	String[]	require parameters

Constructor

New(name:String, props:Set<ParameterType>, req_params:String[], desc:String)

Parameters

Name	Type	Description
name	String	function parameter name
props	Set<ParameterType>	set of named parameter properties
req_params	String[]	require parameters
desc	String	description

Compare

Compares two objects

method : public : Compare(rhs:System.Compare) ~ Int

Parameters

Name	Type	Description
rhs	Compare	compare object

Return

Type	Description
Int	0 if equal, -1 if right-hand side i greater, 1 if left-hand side is greater

GetDesc

Get the function description

method : public : GetDesc() ~ String

Return

Type	Description
String	function description

GetName

Get the function name

method : public : GetName() ~ String

Return

Type	Description
String	function name

GetProps

Get parameter properties object descriptions

method : public : GetProps() ~ Set<ParameterType>

Return

Type	Description
Set<ParameterType>	properties object descriptions

GetType

Get parameter type

method : public : GetType() ~ ParameterType->Type

Return

Type	Description
ParameterType->Type	parameter type

HashID

Returns a hash ID for the given class

method : public : HashID() ~ Int

Return

Type	Description
Int	hash ID

ToJson

JSON element representation

method : public : ToJson() ~ JsonElement

Return

Type	Description
JsonElement	JSON element representation

ToString

JSON string representation

method : public : ToString() ~ String

Return

Type	Description
String	JSON string representation