Package adams.parser.plugin

Class Env

java.lang.Object

adams.core.logging.LoggingObject

adams.parser.plugin.AbstractParserFunction

adams.parser.plugin.Env

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, ParserFunction, Serializable

public class Env
extends AbstractParserFunction

Example function that simply outputs the parameters on the command-line.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
Env()

Method Summary

Modifier and Type	Method	Description
protected String	check(Object[] params)	Performs some checks on the input parameters.
protected Object	doCallFunction(Object[] params)	Gets called from the parser.
String	getFunctionHelp()	Returns the help string for the function.
String	getFunctionName()	Returns the function name.
String	getFunctionSignature()	Returns the signature of the function.

Methods inherited from class adams.parser.plugin.AbstractParserFunction

callFunction, getFunctions

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Constructor Detail

Env

public Env()

Method Detail

getFunctionName

public String getFunctionName()

Returns the function name. Can only consist of letters, underscores, numbers.

Specified by:

getFunctionName in interface ParserFunction

Specified by:

getFunctionName in class AbstractParserFunction

Returns:

the name of the function

getFunctionSignature

public String getFunctionSignature()

Returns the signature of the function.

Specified by:

getFunctionSignature in interface ParserFunction

Specified by:

getFunctionSignature in class AbstractParserFunction

Returns:

the signature

getFunctionHelp

public String getFunctionHelp()

Returns the help string for the function.

Specified by:

getFunctionHelp in interface ParserFunction

Specified by:

getFunctionHelp in class AbstractParserFunction

Returns:

the help string

check

protected String check(Object[] params)

Performs some checks on the input parameters.

Specified by:

check in class AbstractParserFunction

Parameters:

params - the input parameters

Returns:

always null

doCallFunction

protected Object doCallFunction(Object[] params)

Gets called from the parser.

Specified by:

doCallFunction in class AbstractParserFunction

Parameters:

params - the parameters obtained through the parser

Returns:

the result to be used further in the parser