byucc.jhdl.apps.util
Class PropertiesGetCommand

java.lang.Object
  byucc.jhdl.apps.util.PropertiesGetCommand

All Implemented Interfaces:

CLICommand

public class PropertiesGetCommand

extends java.lang.Object

implements CLICommand

Field Summary

static java.lang.String	HELP_TEXT Gives the purpose and function of this command
static java.lang.String	TYPE_PROPERTIES Indicates the category for this command
static java.lang.String	USAGE_TEXT Gives the usage syntax for this command

Fields inherited from interface byucc.jhdl.util.cli.CLICommand

OVERLOAD

Constructor Summary

PropertiesGetCommand()

Method Summary

java.lang.Object	execute(CLInterpreter parent, java.lang.String[] args) The main processing method for this command
java.lang.String	getHelpText(java.lang.String commandName)
java.lang.String	getHelpType(java.lang.String commandName) Returns the classification for this command
java.lang.String	getUsageText(java.lang.String commandName)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_PROPERTIES

public static final java.lang.String TYPE_PROPERTIES

Indicates the category for this command

See Also:

Constant Field Values

HELP_TEXT

public static final java.lang.String HELP_TEXT

Gives the purpose and function of this command

See Also:

Constant Field Values

USAGE_TEXT

public static final java.lang.String USAGE_TEXT

Gives the usage syntax for this command

See Also:

Constant Field Values

Constructor Detail

PropertiesGetCommand

public PropertiesGetCommand()

Method Detail

execute

public java.lang.Object execute(CLInterpreter parent,
                                java.lang.String[] args)
                         throws CLIException

The main processing method for this command

Specified by:

execute in interface CLICommand

Parameters:

parent - the CLInterpreter that is executing this command

args - the arguments (including the command name itself) for this command

Throws:

CLIException

getHelpText

public java.lang.String getHelpText(java.lang.String commandName)

Specified by:

getHelpText in interface CLICommand

Returns:

a string giving information on what this command does

getHelpType

public java.lang.String getHelpType(java.lang.String commandName)

Returns the classification for this command

Specified by:

getHelpType in interface CLICommand

getUsageText

public java.lang.String getUsageText(java.lang.String commandName)

Specified by:

getUsageText in interface CLICommand

Returns:

the command line usage syntax