com.adventnet.cli.messageset
Class CLICommandTemplate

java.lang.Object
  |
  +--com.adventnet.cli.messageset.CLICommandTemplate

public class CLICommandTemplate

extends java.lang.Object

implements java.io.Serializable

This class contains the Command Template read from a template definitions file. The object contains a list of cmdObjects, parameters and options. The API user need not instantiate this class since it is done during parsing of the template definitions file.

See Also:

Serialized Form

Constructor Summary

CLICommandTemplate()
Default constructor to create an instance of CLICommandTemplate.

Method Summary

com.adventnet.cli.messageset.CmdHelp	getCmdHelp() Gets the help of this Command Template.
CmdObject[]	getCmdObjectList() Gets the command object list.
com.adventnet.cli.messageset.CmdOptions	getCmdOptionsList() Gets the CmdOptions object for the Command Template.
CmdParams[]	getCmdParamsList() Gets the command param list for the Command Template.
java.lang.String	getCommandDelimiter() Gets the command Delimiter for the Command Template.
java.lang.String	getCommandName() Gets the command name for the template.
void	setCmdHelp(com.adventnet.cli.messageset.CmdHelp help) Sets the help for this Command Template.
void	setCmdObjectList(CmdObject[] objectList) Sets the command object list for the Command Template.
void	setCmdOptionsList(com.adventnet.cli.messageset.CmdOptions cmdOpt) Sets the command option for the Command Template.
void	setCmdParamsList(CmdParams[] cmdParamList) Sets the command param list for the Command Template.
void	setCommandDelimiter(java.lang.String cmdDelimiter) Sets the delimiter for the Command Template.
void	setCommandName(java.lang.String name) Sets the name for the Command Template.
java.lang.String	toString() Method to get the String representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CLICommandTemplate

public CLICommandTemplate()

Default constructor to create an instance of CLICommandTemplate.

Method Detail

setCmdObjectList

public void setCmdObjectList(CmdObject[] objectList)

Sets the command object list for the Command Template.

Parameters:

objectList - The array of CmdObject objects.

getCmdObjectList

public CmdObject[] getCmdObjectList()

Gets the command object list. The objects returned from this may in turn contain child CmdObject lists.

Returns:

array of CmdObject objects.

setCmdParamsList

public void setCmdParamsList(CmdParams[] cmdParamList)

Sets the command param list for the Command Template.

Parameters:

cmdParamList - The array of CmdParams objects.

getCmdParamsList

public CmdParams[] getCmdParamsList()

Gets the command param list for the Command Template.

Returns:

array of CmdParams objects.

setCmdOptionsList

public void setCmdOptionsList(com.adventnet.cli.messageset.CmdOptions cmdOpt)

Sets the command option for the Command Template.

Parameters:

The - CmdOptions object.

getCmdOptionsList

public com.adventnet.cli.messageset.CmdOptions getCmdOptionsList()

Gets the CmdOptions object for the Command Template.

Returns:

CmdOptions object.

setCommandName

public void setCommandName(java.lang.String name)

Sets the name for the Command Template.

Parameters:

name - to be set for the Command Template.

getCommandName

public java.lang.String getCommandName()

Gets the command name for the template. This uniquely identifies the command in a command set.

Returns:

the command name as a String.

setCommandDelimiter

public void setCommandDelimiter(java.lang.String cmdDelimiter)

Sets the delimiter for the Command Template.

Parameters:

the - command delimiter to be set as a String.

getCommandDelimiter

public java.lang.String getCommandDelimiter()

Gets the command Delimiter for the Command Template.

Returns:

the command delimiter as a String.

getCmdHelp

public com.adventnet.cli.messageset.CmdHelp getCmdHelp()

Gets the help of this Command Template.

Returns:

CmdHelp object for the command.

setCmdHelp

public void setCmdHelp(com.adventnet.cli.messageset.CmdHelp help)

Sets the help for this Command Template.

Parameters:

the - CmdHelp object to be set for the CLICommandTemplate.

toString

public java.lang.String toString()

Method to get the String representation of this object. Returns the command name.

Overrides:

toString in class java.lang.Object

Returns:

returns the command name.