dev.siris.module

Class ModuleCommand

java.lang.Object

org.bukkit.command.Command

dev.siris.module.ModuleCommand

All Implemented Interfaces:

org.bukkit.command.PluginIdentifiableCommand

public class ModuleCommand
extends org.bukkit.command.Command
implements org.bukkit.command.PluginIdentifiableCommand

Mostly inspired code from PluginCommand with elements retrofitted for modules.

See Also:

PluginCommand

Field Summary

Fields inherited from class org.bukkit.command.Command

description, timings, usageMessage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModuleCommand(@NotNull String name, @NotNull Module owner)

Method Summary

Modifier and Type	Method and Description
boolean	execute(@NotNull org.bukkit.command.CommandSender sender, @NotNull String commandLabel, @NotNull String[] args) Executes the command, returning its success
@NotNull org.bukkit.command.CommandExecutor	getExecutor() Gets the CommandExecutor associated with this command
@NotNull org.bukkit.plugin.Plugin	getPlugin() Gets the owner of this PluginCommand
@Nullable org.bukkit.command.TabCompleter	getTabCompleter() Gets the TabCompleter associated with this command.
void	setExecutor(@Nullable org.bukkit.command.CommandExecutor executor) Sets the CommandExecutor to run when parsing this command
void	setTabCompleter(@Nullable org.bukkit.command.TabCompleter completer) Sets the TabCompleter to run when tab-completing this command.
@NotNull List<String>	tabComplete(@NotNull org.bukkit.command.CommandSender sender, @NotNull String alias, @NotNull String[] args)
String	toString()

Methods inherited from class org.bukkit.command.Command

broadcastCommandMessage, broadcastCommandMessage, getAliases, getDescription, getLabel, getName, getPermission, getPermissionMessage, getUsage, isRegistered, register, setAliases, setDescription, setLabel, setName, setPermission, setPermissionMessage, setUsage, tabComplete, testPermission, testPermissionSilent, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleCommand

protected ModuleCommand(@NotNull
                        @NotNull String name,
                        @NotNull
                        @NotNull Module owner)

Method Detail

execute

public boolean execute(@NotNull
                       @NotNull org.bukkit.command.CommandSender sender,
                       @NotNull
                       @NotNull String commandLabel,
                       @NotNull
                       @NotNull String[] args)

Executes the command, returning its success

Specified by:

execute in class org.bukkit.command.Command

Parameters:

sender - Source object which is executing this command

commandLabel - The alias of the command used

args - All arguments passed to the command, split via ' '

Returns:

true if the command was successful, otherwise false

setExecutor

public void setExecutor(@Nullable
                        @Nullable org.bukkit.command.CommandExecutor executor)

Sets the CommandExecutor to run when parsing this command

Parameters:

executor - New executor to run

getExecutor

@NotNull
public @NotNull org.bukkit.command.CommandExecutor getExecutor()

Gets the CommandExecutor associated with this command

Returns:

CommandExecutor object linked to this command

setTabCompleter

public void setTabCompleter(@Nullable
                            @Nullable org.bukkit.command.TabCompleter completer)

Sets the TabCompleter to run when tab-completing this command.

If no TabCompleter is specified, and the command's executor implements TabCompleter, then the executor will be used for tab completion.

Parameters:

completer - New tab completer

getTabCompleter

@Nullable
public @Nullable org.bukkit.command.TabCompleter getTabCompleter()

Gets the TabCompleter associated with this command.

Returns:

TabCompleter object linked to this command

getPlugin

@NotNull
public @NotNull org.bukkit.plugin.Plugin getPlugin()

Gets the owner of this PluginCommand

Specified by:

getPlugin in interface org.bukkit.command.PluginIdentifiableCommand

Returns:

Plugin that owns this command

tabComplete

@NotNull
public @NotNull List<String> tabComplete(@NotNull
                                                  @NotNull org.bukkit.command.CommandSender sender,
                                                  @NotNull
                                                  @NotNull String alias,
                                                  @NotNull
                                                  @NotNull String[] args)
                                           throws org.bukkit.command.CommandException,
                                                  IllegalArgumentException

Delegates to the tab completer if present.

If it is not present or returns null, will delegate to the current command executor if it implements TabCompleter. If a non-null list has not been found, will default to standard player name completion in Command.tabComplete(CommandSender, String, String[]).

This method does not consider permissions.

Overrides:

tabComplete in class org.bukkit.command.Command

Throws:

org.bukkit.command.CommandException - if the completer or executor throw an exception during the process of tab-completing.

IllegalArgumentException - if sender, alias, or args is null

toString

public String toString()

Overrides:

toString in class org.bukkit.command.Command