com.simplifiedlogic.nitro.jshell.json.template

Class FunctionSpec

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.template.FunctionSpec

public class FunctionSpec
extends java.lang.Object

Help-doc class which represents a complete function specification.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_ARRAY
static java.lang.String	TYPE_BOOL
static java.lang.String	TYPE_DEPEND
static java.lang.String	TYPE_DOUBLE
static java.lang.String	TYPE_INTEGER
static java.lang.String	TYPE_OBJARRAY
static java.lang.String	TYPE_OBJECT
static java.lang.String	TYPE_STRING

Constructor Summary

Constructors

Constructor and Description
FunctionSpec()

Method Summary

Methods

Modifier and Type	Method and Description
void	addArgument(FunctionArgument arg) Add a function argument to the spec
void	addFootnote(java.lang.String note) Add a line of footnote to the spec.
void	addReturn(FunctionReturn ret) Add a return value to the spec
java.util.List<java.lang.String>	getFootnotes() Get the function footnotes
java.lang.String	getFunctionDescription()
java.util.Map<java.lang.String,java.lang.Object>	getObject(FunctionTemplate template) Convert the data into a generic Map object
java.util.List<FunctionArgument>	getRequest() Get the list of function arguments
java.util.List<FunctionReturn>	getResponse() Get the list of function return values
boolean	isHasSessionInput()
boolean	isHasSessionOutput()
void	setFunctionDescription(java.lang.String functionDescription)
void	setHasSessionInput(boolean hasSessionInput)
void	setHasSessionOutput(boolean hasSessionOutput)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_STRING

public static final java.lang.String TYPE_STRING

See Also:

Constant Field Values

TYPE_INTEGER

public static final java.lang.String TYPE_INTEGER

See Also:

Constant Field Values

TYPE_DOUBLE

public static final java.lang.String TYPE_DOUBLE

See Also:

Constant Field Values

TYPE_BOOL

public static final java.lang.String TYPE_BOOL

See Also:

Constant Field Values

TYPE_ARRAY

public static final java.lang.String TYPE_ARRAY

See Also:

Constant Field Values

TYPE_OBJECT

public static final java.lang.String TYPE_OBJECT

See Also:

Constant Field Values

TYPE_OBJARRAY

public static final java.lang.String TYPE_OBJARRAY

See Also:

Constant Field Values

TYPE_DEPEND

public static final java.lang.String TYPE_DEPEND

See Also:

Constant Field Values

Constructor Detail

FunctionSpec

public FunctionSpec()

Method Detail

addArgument

public void addArgument(FunctionArgument arg)

Add a function argument to the spec

Parameters:

arg - The argument definition

addReturn

public void addReturn(FunctionReturn ret)

Add a return value to the spec

Parameters:

ret - The return value definition

addFootnote

public void addFootnote(java.lang.String note)

Add a line of footnote to the spec. These are additional notes which will appear in the header of the help doc

Parameters:

note - Footnote text, intended to be a single footnote

getObject

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

Convert the data into a generic Map object

Parameters:

template - The function template which owns this spec

Returns:

The converted data object

getFunctionDescription

public java.lang.String getFunctionDescription()

Returns:

The function description

setFunctionDescription

public void setFunctionDescription(java.lang.String functionDescription)

Parameters:

functionDescription - The function description

getRequest

public java.util.List<FunctionArgument> getRequest()

Get the list of function arguments

Returns:

The list of function arguments

getResponse

public java.util.List<FunctionReturn> getResponse()

Get the list of function return values

Returns:

The list of function return values

getFootnotes

public java.util.List<java.lang.String> getFootnotes()

Get the function footnotes

Returns:

The list of footnotes

isHasSessionInput

public boolean isHasSessionInput()

Returns:

Whether the function requires a session ID. Defaults to true.

setHasSessionInput

public void setHasSessionInput(boolean hasSessionInput)

Parameters:

hasSessionInput - Whether the function requires a session ID. Defaults to true.

isHasSessionOutput

public boolean isHasSessionOutput()

Returns:

Whether the function can return a session ID. Defaults to false.

setHasSessionOutput

public void setHasSessionOutput(boolean hasSessionOutput)

Parameters:

hasSessionOutput - Whether the function can return a session ID. Defaults to false.