com.simplifiedlogic.nitro.jshell.json.template

Class FunctionExample

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.template.FunctionExample

public class FunctionExample
extends java.lang.Object

Help-doc class which represents an example of function usage.

Constructor Summary

Constructors

Constructor and Description
FunctionExample()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInput(java.lang.String name, java.lang.Object value) Add an input argument to the example
void	addOutput(java.lang.String name, java.lang.Object value) Add an output result to the example
void	createError(java.lang.String msg) Add an error result to the example
java.util.Map<java.lang.String,java.lang.Object>	getInput() Get the list of input arguments for the example
java.util.Map<java.lang.String,java.lang.Object>	getObject(FunctionTemplate template) Convert the data into a generic Map object
java.util.Map<java.lang.String,java.lang.Object>	getOutput() Get the list of output results for the example

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionExample

public FunctionExample()

Method Detail

addInput

public void addInput(java.lang.String name,
            java.lang.Object value)

Add an input argument to the example

Parameters:

name - The field name

value - The field value

addOutput

public void addOutput(java.lang.String name,
             java.lang.Object value)

Add an output result to the example

Parameters:

name - The field name

value - The field value

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

createError

public void createError(java.lang.String msg)

Add an error result to the example

Parameters:

msg - The text of the error

getInput

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

Get the list of input arguments for the example

Returns:

The list of input arguments

getOutput

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

Get the list of output results for the example

Returns:

The list of output results