com.moomoohk.MooCommands

Class Command

java.lang.Object

com.moomoohk.MooCommands.Command

Direct Known Subclasses:

HelpCommand

public abstract class Command
extends java.lang.Object

This abstract class represents an executable command.

Since:

2013-11-24

Version:

2.0

Author:

Meshulam Silk (moomoohk@ymail.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	outputColor
protected java.lang.String	outputMessage

Constructor Summary

Constructors

Constructor and Description
Command() Creates a new Command object and adds it to the CommandsManager list.

Method Summary

Modifier and Type	Method and Description
protected 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.
java.lang.String	checkAndExecute(java.lang.String[] params) This method will check the validity of the parameters and execute it if the check is successful.
protected abstract void	execute(java.lang.String[] params) The execute code. You should never really have to explicitly call this method.
abstract java.lang.String	getCommand() Gets this command as a String.
abstract java.lang.String	getHelpMessage() Gets this command's help message.
abstract int	getMaxParams() Gets the maximum number of parameters this command can be used with.
abstract int	getMinParams() Gets the minimum number of parameters this command can be used with.
java.awt.Color	getOutputColor() Gets the color that this command's output text should be printed with.
abstract java.lang.String	getUsage() Gets the proper usage of this command.
protected void	missingParameters(java.lang.String[] params) This method gets called if the check method finds that the parameter array provided contains too little parameters.
protected void	tooManyParameters(java.lang.String[] params) This method gets called if the check method finds that the parameter array provided contains too many parameters.
java.lang.String	toString() Returns a String containing information about this command using the following format: [This command as a String]: [This command's help message or "<no help message specified>" if none specified], Usage: [This command's usage or "<none specified>" if none specified]

Methods inherited from class java.lang.Object

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

Field Detail

outputMessage

protected java.lang.String outputMessage

outputColor

protected java.awt.Color outputColor

Constructor Detail

Command

public Command()

Creates a new Command object and adds it to the CommandsManager list.

Method Detail

getCommand

public abstract java.lang.String getCommand()

Gets this command as a String.

Returns:

The command as a String.

getHelpMessage

public abstract java.lang.String getHelpMessage()

Gets this command's help message.

Returns:

This commands's help message.

getUsage

public abstract java.lang.String getUsage()

Gets the proper usage of this command.

Returns:

The proper usage of this command.

getMaxParams

public abstract int getMaxParams()

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

Returns:

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

getMinParams

public abstract int getMinParams()

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

Returns:

The minimum number of parameters this command be used with.

getOutputColor

public java.awt.Color getOutputColor()

Gets the color that this command's output text should be printed with.

For example, suppose the command's output text indicates that some error has occurred, the color returned would be red.
This color doesn't matter unless this command's output is being printed with a colored text compatible handler.

Returns:

The color that this command's output text should be printed with.

checkAndExecute

public java.lang.String checkAndExecute(java.lang.String[] params)

This method will check the validity of the parameters and execute it if the check is successful.

Parameters:

params - A String array of the parameters you'd like to execute this command with.

Returns:

The command's output message

check

protected 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. Use checkAndExecute(String[]) instead.

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

Parameters:

params - A String array of parameters.

Returns:

True if the check is successful, else false.

execute

protected abstract void execute(java.lang.String[] params)

The execute code.
You should never really have to explicitly call this method. Use 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.

Parameters:

params - A String array of parameters.

missingParameters

protected void missingParameters(java.lang.String[] params)

This method gets called if the check method finds that the parameter array provided contains too little parameters.

By default it sets this command's output message to "Missing parameters!" and this command's output color to red.

Parameters:

params - A String array of parameters.

tooManyParameters

protected void tooManyParameters(java.lang.String[] params)

This method gets called if the check method finds that the parameter array provided contains too many parameters.

By default it sets this command's output message to "Too many parameters!" and this command's output color to red.

Parameters:

params - A String array of parameters.

toString

public java.lang.String toString()

Returns a String containing information about this command using the following format:
[This command as a String]: [This command's help message or "<no help message specified>" if none specified], Usage: [This command's usage or "<none specified>" if none specified]

Overrides:

toString in class java.lang.Object

Returns:

A String containing information about this command.