com.prosyst.util.pcommands
Class CommandInfo

java.lang.Object
  com.prosyst.util.pcommands.CommandInfo

public class CommandInfo
extends java.lang.Object

This class represents an executable command in the PluggableCommands.

Author:

Daniel Janev

See Also:

PluggableCommands.getCommandsInfo()

Constructor Summary

CommandInfo(java.lang.String[] names, java.lang.String description, java.lang.String[] params)
This constructor creates new CommandInfo according to the parameters below.

Method Summary

java.lang.String	getDescription() This method returns the description of the command.
java.lang.String[]	getNames() This method returns the names of the command.
java.lang.String[]	getParams() This method returns the parameters of the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandInfo

public CommandInfo(java.lang.String[] names,
                   java.lang.String description,
                   java.lang.String[] params)

This constructor creates new CommandInfo according to the parameters below.

Parameters:

names - the names of the command. The element at index 0 is the full command name, next elements are the shortcuts of the commnad.

description - the description of the command.

params - the paramets of the command and their description. The elements at 2 * i contains the parameter and the elements at 2 * i + 1 contains the parameter description where i >= 0.

Method Detail

getNames

public java.lang.String[] getNames()

This method returns the names of the command. The element at index 0 is the full command name, next elements are the shortcuts of the commnad.

Returns:

the names of the command represented by CommandInfo object.

getDescription

public java.lang.String getDescription()

This method returns the description of the command.

Returns:

the description of the command represented by CommandInfo object.

getParams

public java.lang.String[] getParams()

This method returns the parameters of the command. The elements at 2 * i contains the parameter and the elements at 2 * i + 1 contains the parameter description where i >= 0.

Returns:

the parameters of the command represented by CommandInfo object.