Package adams.parser.plugin

Class Println

java.lang.Object

adams.core.logging.LoggingObject

adams.parser.plugin.AbstractParserProcedure

adams.parser.plugin.Println

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, ParserProcedure, Serializable

public class Println
extends AbstractParserProcedure

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

Version:

$Revision$

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
Println()

Method Summary

Modifier and Type	Method	Description
protected String	check(Object[] params)	Performs some checks on the input parameters.
protected void	doCallProcedure(Object[] params)	Gets called from the parser.
String	getProcedureHelp()	Returns the help string for the procedure.
String	getProcedureName()	Returns the procedure name.
String	getProcedureSignature()	Returns the signature of the procedure.

Methods inherited from class adams.parser.plugin.AbstractParserProcedure

callProcedure, getProcedures

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

Println

public Println()

Method Detail

getProcedureName

public String getProcedureName()

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

Specified by:

getProcedureName in interface ParserProcedure

Specified by:

getProcedureName in class AbstractParserProcedure

Returns:

the name of the procedure

getProcedureSignature

public String getProcedureSignature()

Returns the signature of the procedure.

Specified by:

getProcedureSignature in interface ParserProcedure

Specified by:

getProcedureSignature in class AbstractParserProcedure

Returns:

the signature

getProcedureHelp

public String getProcedureHelp()

Returns the help string for the procedure.

Specified by:

getProcedureHelp in interface ParserProcedure

Specified by:

getProcedureHelp in class AbstractParserProcedure

Returns:

the help string

check

protected String check(Object[] params)

Performs some checks on the input parameters.

Specified by:

check in class AbstractParserProcedure

Parameters:

params - the input parameters

Returns:

always null

doCallProcedure

protected void doCallProcedure(Object[] params)

Gets called from the parser.

Specified by:

doCallProcedure in class AbstractParserProcedure

Parameters:

params - the parameters obtained through the parser