com.codelanx.codelanxlib.command

Class CommandHandler<E extends org.bukkit.plugin.Plugin>

java.lang.Object

com.codelanx.codelanxlib.command.CommandHandler<E>

Type Parameters:

E - The specific Plugin to use

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter

public class CommandHandler<E extends org.bukkit.plugin.Plugin>
extends Object
implements org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter

Manages commands abstractly for the Plugin

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected String	command The primary command to access this CommandHandler in-game
protected Map<String,SubCommand<E>>	commands Private HashMap of subcommands
protected Lang	name The format for output
protected E	plugin Private Plugin instance

Constructor Summary

Constructors

Constructor and Description
CommandHandler(E plugin, String command) CommandHandler constructor.

Method Summary

Modifier and Type	Method and Description
SubCommand<E>	getCommand(String name) Returns a subcommand, or null if none exists.
Collection<SubCommand<E>>	getCommands() Returns all subcommands as a Collection.
String	getMainCommand() Returns the main command associated with this CommandHandler
boolean	isRegistered(String name) Checks to see if a SubCommand is registered under the passed command name
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command cmd, String commandLabel, String[] args) Executes the proper SubCommand
List<String>	onTabComplete(org.bukkit.command.CommandSender sender, org.bukkit.command.Command command, String alias, String[] args)
<T extends SubCommand<E>> T	registerSubCommand(T command) Registers a SubCommand under the main supplied command name
<T extends SubCommand<E>> void	registerSubCommands(T... commands) Registers multiple SubCommand instance under the provided command name.
void	unregisterSubCommand(String name) Removes a SubCommand in use by this handler.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final Lang name

The format for output

plugin

protected final E extends org.bukkit.plugin.Plugin plugin

Private Plugin instance

commands

protected final Map<String,SubCommand<E extends org.bukkit.plugin.Plugin>> commands

Private HashMap of subcommands

command

protected String command

The primary command to access this CommandHandler in-game

Constructor Detail

CommandHandler

public CommandHandler(E plugin,
                      String command)

CommandHandler constructor. Sets fields and registers the main command through Bukkit to be executed by this handler.

Parameters:

plugin - The main Plugin instance

command - The command to write subcommands under

Since:

0.0.1

Method Detail

onCommand

public boolean onCommand(org.bukkit.command.CommandSender sender,
                         org.bukkit.command.Command cmd,
                         String commandLabel,
                         String[] args)

Executes the proper SubCommand

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

Parameters:

sender -

cmd - The command instance which was executed

commandLabel -

args -

Returns:

false

Since:

0.0.1

onTabComplete

public List<String> onTabComplete(org.bukkit.command.CommandSender sender,
                                  org.bukkit.command.Command command,
                                  String alias,
                                  String[] args)

Specified by:

onTabComplete in interface org.bukkit.command.TabCompleter

Parameters:

sender -

command -

alias -

args -

Returns:

Since:

0.1.0

getCommand

public final SubCommand<E> getCommand(String name)

Returns a subcommand, or null if none exists.

Parameters:

name - The name of the subcommand

Returns:

A relevant SubCommand, or null if it does not exist

Since:

0.0.1

getCommands

public final Collection<SubCommand<E>> getCommands()

Returns all subcommands as a Collection.

Returns:

A Collection of all registered SubCommand

Since:

0.0.1

registerSubCommand

public final <T extends SubCommand<E>> T registerSubCommand(T command)

Registers a SubCommand under the main supplied command name

Type Parameters:

T - The subcommand type

Parameters:

command - The SubCommand to register

Returns:

The registered subcommand

Throws:

IllegalArgumentException - If the command's name is already in use

Since:

0.0.1

registerSubCommands

public final <T extends SubCommand<E>> void registerSubCommands(T... commands)

Registers multiple SubCommand instance under the provided command name. If an exception is encountered, it will continue registering commands and re-throw the exception upon method completion.

Type Parameters:

T - The subcommand type

Parameters:

commands - The SubCommand instances to register

Throws:

IllegalArgumentException - If the command's name is already in use

Since:

0.0.1

unregisterSubCommand

public void unregisterSubCommand(String name)

Removes a SubCommand in use by this handler. If no SubCommand is registered under the name, then nothing happens

Parameters:

name - The command to check for

Since:

0.1.0

isRegistered

public boolean isRegistered(String name)

Checks to see if a SubCommand is registered under the passed command name

Parameters:

name - The command to check for

Returns:

true if registered to a SubCommand

Since:

0.1.0

getMainCommand

public String getMainCommand()

Returns the main command associated with this CommandHandler

Returns:

The main command

Since:

0.0.1