Package cc.carm.lib.easyplugin.command

Class CommandHandler

java.lang.Object

cc.carm.lib.easyplugin.command.CommandHandler

All Implemented Interfaces:

NamedExecutor, org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor

public abstract class CommandHandler
extends java.lang.Object
implements org.bukkit.command.TabExecutor, NamedExecutor

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull java.util.List<java.lang.String>	aliases
protected @NotNull java.util.Map<java.lang.String,java.lang.String>	aliasesMap
protected @NotNull java.lang.String	cmd
protected @NotNull org.bukkit.plugin.java.JavaPlugin	plugin
protected @NotNull java.util.Map<java.lang.String,SubCommand<?>>	registeredCommands
protected @NotNull java.util.Map<java.lang.String,CommandHandler>	registeredHandlers

Constructor Summary

Constructors

Constructor	Description
CommandHandler(@NotNull org.bukkit.plugin.java.JavaPlugin plugin)
CommandHandler(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull java.lang.String cmd)
CommandHandler(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull java.lang.String cmd, @NotNull java.lang.String... aliases)

Method Summary

Modifier and Type	Method	Description
@NotNull java.util.List<java.lang.String>	getAliases()
java.util.List<NamedExecutor>	getExecutors()
protected @Nullable CommandHandler	getHandler(@NotNull java.lang.String name)
@NotNull java.lang.String	getIdentifier()
protected @Nullable SubCommand<?>	getSubCommand(@NotNull java.lang.String name)
abstract java.lang.Void	noArgs(org.bukkit.command.CommandSender sender)
abstract java.lang.Void	noPermission(org.bukkit.command.CommandSender sender)
boolean	onCommand(@NotNull org.bukkit.command.CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull java.lang.String label, java.lang.String[] args)
java.lang.Void	onException(org.bukkit.command.CommandSender sender, SubCommand<?> cmd, java.lang.Exception ex)
java.util.List<java.lang.String>	onTabComplete(@NotNull org.bukkit.command.CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull java.lang.String alias, java.lang.String[] args)
void	registerHandler(CommandHandler handler)
void	registerSubCommand(SubCommand<?> command)
protected java.lang.String[]	shortenArgs(java.lang.String[] args)
java.lang.Void	unknownCommand(org.bukkit.command.CommandSender sender, java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Methods inherited from interface cc.carm.lib.easyplugin.command.NamedExecutor

hasPermission, sendMessage, sendMessage

Field Detail

plugin

@NotNull
protected final @NotNull org.bukkit.plugin.java.JavaPlugin plugin

cmd

@NotNull
protected final @NotNull java.lang.String cmd

aliases

@NotNull
protected final @NotNull java.util.List<java.lang.String> aliases

registeredCommands

@NotNull
protected final @NotNull java.util.Map<java.lang.String,SubCommand<?>> registeredCommands

registeredHandlers

@NotNull
protected final @NotNull java.util.Map<java.lang.String,CommandHandler> registeredHandlers

aliasesMap

@NotNull
protected final @NotNull java.util.Map<java.lang.String,java.lang.String> aliasesMap

Constructor Detail

CommandHandler

public CommandHandler(@NotNull
                      @NotNull org.bukkit.plugin.java.JavaPlugin plugin)

CommandHandler

public CommandHandler(@NotNull
                      @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
                      @NotNull
                      @NotNull java.lang.String cmd)

CommandHandler

public CommandHandler(@NotNull
                      @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
                      @NotNull
                      @NotNull java.lang.String cmd,
                      @NotNull
                      @NotNull java.lang.String... aliases)

Method Detail

noArgs

public abstract java.lang.Void noArgs(org.bukkit.command.CommandSender sender)

unknownCommand

public java.lang.Void unknownCommand(org.bukkit.command.CommandSender sender,
                                     java.lang.String[] args)

noPermission

public abstract java.lang.Void noPermission(org.bukkit.command.CommandSender sender)

onException

public java.lang.Void onException(org.bukkit.command.CommandSender sender,
                                  SubCommand<?> cmd,
                                  java.lang.Exception ex)

getAliases

@NotNull
public @NotNull java.util.List<java.lang.String> getAliases()

Specified by:

getAliases in interface NamedExecutor

getIdentifier

@NotNull
public @NotNull java.lang.String getIdentifier()

Specified by:

getIdentifier in interface NamedExecutor

registerSubCommand

public void registerSubCommand(SubCommand<?> command)

registerHandler

public void registerHandler(CommandHandler handler)

onCommand

public boolean onCommand(@NotNull
                         @NotNull org.bukkit.command.CommandSender sender,
                         @NotNull
                         @NotNull org.bukkit.command.Command command,
                         @NotNull
                         @NotNull java.lang.String label,
                         java.lang.String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

onTabComplete

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

Specified by:

onTabComplete in interface org.bukkit.command.TabCompleter

getExecutors

public java.util.List<NamedExecutor> getExecutors()

getHandler

@Nullable
protected @Nullable CommandHandler getHandler(@NotNull
                                              @NotNull java.lang.String name)

getSubCommand

@Nullable
protected @Nullable SubCommand<?> getSubCommand(@NotNull
                                                @NotNull java.lang.String name)

shortenArgs

protected java.lang.String[] shortenArgs(java.lang.String[] args)