com.moomoohk.MooCommands.example

Class HelpCommand

java.lang.Object

com.moomoohk.MooCommands.Command

com.moomoohk.MooCommands.example.HelpCommand

public class HelpCommand
extends Command

Displays help messages for registered commands. This class is intended to serve as an example but is completely functional and safe to use in any program.

Since:

Jul 17, 2014

Author:

Meshulam Silk (moomoohk@ymail.com)

Field Summary

Fields inherited from class com.moomoohk.MooCommands.Command

outputColor, outputMessage

Constructor Summary

Constructors

Constructor and Description
HelpCommand()

Method Summary

Modifier and Type	Method and Description
boolean	check(java.lang.String[] params) The method that checks the validity of a parameters String array for this command. You should never really have to explicitly call this method.
void	execute(java.lang.String[] params) The execute code. You should never really have to explicitly call this method.
java.lang.String	getCommand() Gets this command as a String.
java.lang.String	getHelpMessage() Gets this command's help message.
int	getMaxParams() Gets the maximum number of parameters this command can be used with.
int	getMinParams() Gets the minimum number of parameters this command can be used with.
java.lang.String	getUsage() Gets the proper usage of this command.

Methods inherited from class com.moomoohk.MooCommands.Command

checkAndExecute, getOutputColor, missingParameters, tooManyParameters, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

public HelpCommand()

Method Detail

check

public boolean check(java.lang.String[] params)

Description copied from class: Command

The method that checks the validity of a parameters String array for this command.
You should never really have to explicitly call this method. Use Command.checkAndExecute(String[]) instead.

The default check method simply checks if the length of the String array of parameters falls within the bounds of Command.getMinParams() and Command.getMaxParams() of this command.

Overrides:

check in class Command

Parameters:

params - A String array of parameters.

Returns:

True if the check is successful, else false.

execute

public void execute(java.lang.String[] params)

Description copied from class: Command

The execute code.
You should never really have to explicitly call this method. Use Command.checkAndExecute(String[]) instead.

Simply put whatever code you'd like to be run in here, and when this command is executed the code will be run.

Specified by:

execute in class Command

Parameters:

params - A String array of parameters.

getCommand

public java.lang.String getCommand()

Description copied from class: Command

Gets this command as a String.

Specified by:

getCommand in class Command

Returns:

The command as a String.

getHelpMessage

public java.lang.String getHelpMessage()

Description copied from class: Command

Gets this command's help message.

Specified by:

getHelpMessage in class Command

Returns:

This commands's help message.

getUsage

public java.lang.String getUsage()

Description copied from class: Command

Gets the proper usage of this command.

Specified by:

getUsage in class Command

Returns:

The proper usage of this command.

getMaxParams

public int getMaxParams()

Description copied from class: Command

Gets the maximum number of parameters this command can be used with. -1 for infinite.

Specified by:

getMaxParams in class Command

Returns:

The maximum number of parameters this command can be used with. -1 for infinite.

getMinParams

public int getMinParams()

Description copied from class: Command

Gets the minimum number of parameters this command can be used with.

Specified by:

getMinParams in class Command

Returns:

The minimum number of parameters this command be used with.