com.adventnet.cli.messageset
Class CmdObject

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

public class CmdObject

extends java.lang.Object

implements java.io.Serializable

This class represents the Objects on which the command is executed. This is filled in from the XML definitions, it contains the parameters and options list, and in turn may contain another object list. This class need not be instantiated by the API user.

See Also:

Serialized Form

Constructor Summary

CmdObject()
Default constructor to create a new instance of CmdObject.

Method Summary

CmdObject[]	getChildCmdObjectList() Gets the CmdObject child list.
java.lang.String	getDescription() Gets the description of this Object.
java.lang.String	getObjectDelimiter() Gets the delimiter of this Object.
java.lang.String	getObjectName() Gets the Object Name.
java.lang.String	getObjectValue() Gets the Object Value.
CmdOptions	getOptionsList() Gets the CmdOptions object.
CmdParams[]	getParameterList() Gets the parameter list for this object.
void	setChildCmdObjectList(CmdObject[] cmdObjectList) Sets the CmdObject child list.
void	setDescription(java.lang.String description) Sets the description for this Object.
void	setObjectDelimiter(java.lang.String delimiter) Sets the delimiter for this object.
void	setObjectName(java.lang.String name) Sets the Object Name.
void	setObjectValue(java.lang.String value) Sets the Object Value.
void	setOptionsList(CmdOptions option) Sets the CmdOptions objects associated with the object.
void	setParameterList(CmdParams[] parameters) Sets the parameter list.
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

CmdObject

public CmdObject()

Default constructor to create a new instance of CmdObject.

Method Detail

setObjectName

public void setObjectName(java.lang.String name)

Sets the Object Name. The object name refers to the type of the object. For eg for a directory this could be 'dir', for an interface card this could be 'interface' and so on.

Parameters:

name - the Object name.

getObjectName

public java.lang.String getObjectName()

Gets the Object Name.

Returns:

the object on which the command takes effect.

setObjectValue

public void setObjectValue(java.lang.String value)

Sets the Object Value. The value of the object is the actual object for which the command takes effect. For eg this could be a filename, an interface name (like eth0), etc.

Parameters:

value - the Object Value.

getObjectValue

public java.lang.String getObjectValue()

Gets the Object Value.

Returns:

the object Value for this object

setChildCmdObjectList

public void setChildCmdObjectList(CmdObject[] cmdObjectList)

Sets the CmdObject child list. Sets the array of CmdObjects.

Parameters:

cmdObjectList - an array of CmdObjects.

getChildCmdObjectList

public CmdObject[] getChildCmdObjectList()

Gets the CmdObject child list. Returns the array of CmdObjects. The CmdObject contains the parameter list.

Returns:

array of CmdObjects.

setParameterList

public void setParameterList(CmdParams[] parameters)

Sets the parameter list. Sets the CmdParams objects associated with the object. The CmdParams contains the parameter type, name, etc.

Parameters:

parameters - The CmdParams array.

getParameterList

public CmdParams[] getParameterList()

Gets the parameter list for this object. The array contains the CmdParams object which contains the parameter name, parameter separator and type.

Returns:

the Array of CmdParams Object.

setOptionsList

public void setOptionsList(CmdOptions option)

Sets the CmdOptions objects associated with the object.

Parameters:

options - The CmdOptions object.

getOptionsList

public CmdOptions getOptionsList()

Gets the CmdOptions object.

Returns:

the CmdOptions Object.

getObjectDelimiter

public java.lang.String getObjectDelimiter()

Gets the delimiter of this Object.

Returns:

delimiter for the object as a String.

setObjectDelimiter

public void setObjectDelimiter(java.lang.String delimiter)

Sets the delimiter for this object.

Parameters:

delimiter - the delimiter as a String.

getDescription

public java.lang.String getDescription()

Gets the description of this Object. The description could be like the meaning of the Object, etc.

Returns:

description for the Object as a String.

setDescription

public void setDescription(java.lang.String description)

Sets the description for this Object. The description could be like the meaning of the Object, etc.

Parameters:

description - the description as a String.

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

returns the Object name.