com.moomoohk.MooCommands

Class CommandsManager

java.lang.Object

com.moomoohk.MooCommands.CommandsManager

public final class CommandsManager
extends java.lang.Object

This class manages all the Commands created.

Since:

2013-11-24

Version:

1.0

Author:

Meshulam Silk (moomoohk@ymail.com)

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.ArrayList<Command>	commands

Constructor Summary

Constructors

Constructor and Description
CommandsManager()

Method Summary

Modifier and Type	Method and Description
static void	add(Command command) Adds a Command to the commands list.
static java.lang.String	executeCommand(java.lang.String commandAndParams) Executes a Command in the commands list.
static Command	findCommand(java.lang.String command) Finds a Command in the commands list.
static java.util.ArrayList<Command>	getAllCommands() Gets the commands list.
static java.util.HashMap<java.lang.String,java.lang.String>	parseFlags(java.lang.String[] params) This method receives a String array of parameters which contain flags (which are formatted "flag:value") and will create a HashMap<String, String> which contains the flags as keys and their values.
static java.lang.String[]	parseParams(java.lang.String params) Will parse the parameters from an input String into a String array. For example: "/test param1 param2" will return {"param1", "param2"}.
static java.lang.String	stringParams(java.lang.String[] params, int start) Receives a String array and combines all the indexes into one String object.

Methods inherited from class java.lang.Object

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

Field Detail

commands

private static java.util.ArrayList<Command> commands

Constructor Detail

CommandsManager

public CommandsManager()

Method Detail

add

public static void add(Command command)

Adds a Command to the commands list.
This method should never be called explicitly.
Commands will call this method from their constructor.

Parameters:

command - Command to add to the list.

findCommand

public static Command findCommand(java.lang.String command)

Finds a Command in the commands list.

Parameters:

command - The Command to find in String form.

This String either the Command itself or the command and some parameters.

Returns:

The Command corresponding to the String sent. Null if not found.

getAllCommands

public static java.util.ArrayList<Command> getAllCommands()

Gets the commands list.

Returns:

The commands list.

executeCommand

public static java.lang.String executeCommand(java.lang.String commandAndParams)
                                       throws InvalidCommandException

Executes a Command in the commands list.

Parameters:

commandAndParams - The command in String form and any parameters to execute with.
Theoretically this can be raw user input.

Returns:

The output message of the Command executed.

Throws:

InvalidCommandException - If the input String's length is 0 or if the command cannot be found.

parseParams

public static java.lang.String[] parseParams(java.lang.String params)

Will parse the parameters from an input String into a String array.
For example: "/test param1 param2" will return {"param1", "param2"}.

Parameters:

params - The input to parse.

Returns:

The parsed parameters.

stringParams

public static java.lang.String stringParams(java.lang.String[] params,
                                            int start)

Receives a String array and combines all the indexes into one String object.

Parameters:

params - A String array of parameters.

start - The index with which to start combining.

Returns:

A String object which contains all the parameters combined starting at the specified index.

parseFlags

public static java.util.HashMap<java.lang.String,java.lang.String> parseFlags(java.lang.String[] params)

This method receives a String array of parameters which contain flags (which are formatted "flag:value") and will create a HashMap<String, String> which contains the flags as keys and their values.

Parameters:

params - String array of parameters where each place contains a flag.

Returns:

A HashMap<String, String> which contains the flags and their values.