com.simplifiedlogic.nitro.jshell.json.template

Class FunctionTemplate

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.template.FunctionTemplate

public class FunctionTemplate
extends java.lang.Object

The top-level Help-doc class which represents a complete function template. This includes both the function spec and a series of examples.

Constructor Summary

Constructors

Constructor and Description
FunctionTemplate(java.lang.String command, java.lang.String function) Standard constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addExample(FunctionExample ex) Add an example to the function
java.lang.String	getCommand()
java.util.List<FunctionExample>	getExamples()
java.lang.String	getFunction()
java.util.Map<java.lang.String,java.lang.Object>	getObject() Convert the data into a generic Map object
FunctionSpec	getSpec()
void	setSpec(FunctionSpec spec)

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionTemplate

public FunctionTemplate(java.lang.String command,
                java.lang.String function)

Standard constructor

Parameters:

command - The command (function family)

function - The function name

Method Detail

addExample

public void addExample(FunctionExample ex)

Add an example to the function

Parameters:

ex - The example definition

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

getSpec

public FunctionSpec getSpec()

Returns:

The function spec

setSpec

public void setSpec(FunctionSpec spec)

Parameters:

spec - The function spec

getExamples

public java.util.List<FunctionExample> getExamples()

Returns:

The list of examples for the function

getCommand

public java.lang.String getCommand()

Returns:

The command name

getFunction

public java.lang.String getFunction()

Returns:

The function name