ParameterType
Function parameter type definition
Operations
Compare
Compares two objects
method : public : Compare(rhs:System.Compare) ~ IntParameters
| 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() ~ StringReturn
| Type | Description |
|---|---|
| String | function description |
GetName
Get the function name
method : public : GetName() ~ StringReturn
| Type | Description |
|---|---|
| String | function name |
GetProps
Get parameter properties object descriptions
method : public : GetProps() ~ Map<String,ParameterType>Return
| Type | Description |
|---|---|
| Map<String,ParameterType> | properties object descriptions |
GetType
Get parameter type
method : public : GetType() ~ ParameterType->TypeReturn
| Type | Description |
|---|---|
| ParameterType->Type | parameter type |
HashID
Returns a hash ID for the given class
method : public : HashID() ~ IntReturn
| Type | Description |
|---|---|
| Int | hash ID |
IsArray
Returns rather the schema specifies an array of entities
method : public : IsArray() ~ BoolReturn
| Type | Description |
|---|---|
| Bool | true the scheme specifies array of entities, false otherwise |
New
Constructor
New(type:ParameterType->Type, )Parameters
| Name | Type | Description |
|---|---|---|
| type | ParameterType->Type | parameter type |
New
+Constructor
New(type:ParameterType->Type, desc:String)Parameters
| Name | Type | Description |
|---|---|---|
| type | ParameterType->Type | parameter type |
| desc | String | description |
New
Constructor
New(req_params:String[], )Parameters
| Name | Type | Description |
|---|---|---|
| req_params | String | require parameters |
New
Constructor
New(type:ParameterType->Type)Parameters
| Name | Type | Description |
|---|---|---|
| type | ParameterType->Type | parameter type |
New
Constructor
New(type:ParameterType->Type, desc:String)Parameters
| Name | Type | Description |
|---|---|---|
| type | ParameterType->Type | parameter type |
| desc | String | description |
New
Constructor
New(req_params:String[])Parameters
| Name | Type | Description |
|---|---|---|
| req_params | String | require parameters |
New
Constructor
New(req_params:String[], desc:String)Parameters
| Name | Type | Description |
|---|---|---|
| req_params | String | require parameters |
| desc | String | description |
SetArray
Set schema to be an array of entities
method : public : SetArray(is_array:Bool) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| is_array | Bool | if true an array of entities, false other |
SetDesc
Set the function description
method : public : SetDesc(desc:String) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| desc | String | sets function description |
SetType
Set parameter type
method : public : SetType(type:ParameterType->Type) ~ NilParameters
| Name | Type | Description |
|---|---|---|
| type | ParameterType->Type | parameter type |
ToJson
JSON element representation
method : public : ToJson() ~ JsonElementReturn
| Type | Description |
|---|---|
| JsonElement | JSON element representation |
ToString
JSON string representation
method : public : ToString() ~ StringReturn
| Type | Description |
|---|---|
| String | JSON string representation |