com.simplifiedlogic.nitro.jshell.json.template

Class FunctionArgument

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.template.FunctionArgument

public class FunctionArgument
extends java.lang.Object

Help-doc class which represents a single JSON argument to a CREOSON function.

Constructor Summary

Constructors

Constructor and Description
FunctionArgument(java.lang.String name, java.lang.String type) Standard constructor.
FunctionArgument(java.lang.String name, java.lang.String type, java.lang.String arrayType) Constructor used to declare arguments of a more complex data type, such as:

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getArrayType()
java.lang.String	getDefaultValue()
java.lang.String	getDescription()
java.lang.String	getName()
java.util.Map<java.lang.String,java.lang.Object>	getObject() Convert the data into a generic Map object
java.lang.String	getType()
java.lang.String[]	getValidValues()
boolean	isRequired()
boolean	isWildcards()
void	setArrayType(java.lang.String arrayType)
void	setDefaultValue(java.lang.String defaultValue)
void	setDescription(java.lang.String description)
void	setName(java.lang.String name)
void	setRequired(boolean required)
void	setType(java.lang.String type)
void	setValidValues(java.lang.String[] validValues)
void	setWildcards(boolean wildcards)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionArgument

public FunctionArgument(java.lang.String name,
                java.lang.String type)

Standard constructor.

Parameters:

name - Field name

type - Data type

FunctionArgument

public FunctionArgument(java.lang.String name,
                java.lang.String type,
                java.lang.String arrayType)

Constructor used to declare arguments of a more complex data type, such as:

- Shared objects (type=TYPE_OBJECT, arrayType=shared object name)
- Arrays of primitives (type=TYPE_ARRAY, arrayType=primitive data type)
- Arrays of shared objects (type=TYPE_OBJARRAY, arrayType=shared object name)

Parameters:

name - Field Type

type - Data type - should be one of TYPE_OBJECT, TYPE_ARRAY, or TYPE_OBJARRAY

arrayType - Data sub-type

Method Detail

getObject

public java.util.Map<java.lang.String,java.lang.Object> getObject()

Convert the data into a generic Map object

Returns:

The converted data object

getName

public java.lang.String getName()

Returns:

The field name

setName

public void setName(java.lang.String name)

Parameters:

name - The field name

getDescription

public java.lang.String getDescription()

Returns:

The field's description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - The field's description

getType

public java.lang.String getType()

Returns:

The field's data type

setType

public void setType(java.lang.String type)

Parameters:

type - The field's data type

isRequired

public boolean isRequired()

Returns:

Whether the field is required

setRequired

public void setRequired(boolean required)

Parameters:

required - Whether the field is required

getDefaultValue

public java.lang.String getDefaultValue()

Returns:

The field's default value. This may be a description of default behavior rather than a specific value.

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Parameters:

defaultValue - The field's default value. This may be a description of default behavior rather than a specific value.

getValidValues

public java.lang.String[] getValidValues()

Returns:

A list of valid values for the field

setValidValues

public void setValidValues(java.lang.String[] validValues)

Parameters:

validValues - A list of valid values for the field

getArrayType

public java.lang.String getArrayType()

Returns:

The data sub-type if type is TYPE_OBJECT, TYPE_ARRAY, or TYPE_OBJARRAY

setArrayType

public void setArrayType(java.lang.String arrayType)

Parameters:

arrayType - The data sub-type if type is TYPE_OBJECT, TYPE_ARRAY, or TYPE_OBJARRAY

isWildcards

public boolean isWildcards()

Returns:

Whether the field allows wildcards

setWildcards

public void setWildcards(boolean wildcards)

Parameters:

wildcards - Whether the field allows wildcards