Package com.ultikits.ultitools.commands

Class UltiToolsCommands

java.lang.Object

com.ultikits.ultitools.abstracts.command.BaseCommandExecutor

com.ultikits.ultitools.commands.UltiToolsCommands

All Implemented Interfaces:

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

@CmdExecutor(description="UltiToolsCommands",
             alias={"ul","ultitools","ulti"},
             requireOp=true)
public class UltiToolsCommands
extends BaseCommandExecutor

The command that reloads UltiTools-API.

Version:

1.0.0

Author:

wisdomme, qianmo

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	RELOAD_FAILED_REPLY_KEY	Framework i18n key: the /ul reload <name> reply when the module's reload threw (#509).
(package private) static final String	RELOAD_PARTIAL_REPLY_KEY	Framework i18n key: the /ul reload <name> reply when the module's reload hook reported parts that did not reload (#529).

Constructor Summary

Constructors

Constructor	Description
UltiToolsCommands()

Method Summary

Modifier and Type	Method	Description
private static String	describeFailure(Throwable failure)	A failure's message for a one-line reply, or its class name when it carries none.
protected void	handleHelp(org.bukkit.command.CommandSender sender)	Handles the help command.
void	help(org.bukkit.command.CommandSender sender)
void	listPlugins(org.bukkit.command.CommandSender sender)
void	reloadAll(org.bukkit.command.CommandSender sender)	/ul reload: reloads the framework and every module, each isolated from the others' failures, and replies the summary to the sender -- which modules failed, if any (#509).
void	reloadPlugin(org.bukkit.command.CommandSender sender, String name)
void	reloadPlugins()	Reloads the framework and every module.
List<String>	suggestModuleNames()

Methods inherited from class com.ultikits.ultitools.abstracts.command.BaseCommandExecutor

addValidator, buildMethodParams, createDefaultValidatorChain, executeCommand, getHelpCommand, getMappings, matchMethod, onCommand, onTabComplete, parseParameters, parseParameterValue, removeValidator, suggest, validateParameterCount

Methods inherited from class java.lang.Object

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

Field Details

RELOAD_FAILED_REPLY_KEY

static final String RELOAD_FAILED_REPLY_KEY

Framework i18n key: the /ul reload <name> reply when the module's reload threw (#509).

See Also:

• Constant Field Values

RELOAD_PARTIAL_REPLY_KEY

static final String RELOAD_PARTIAL_REPLY_KEY

Framework i18n key: the /ul reload <name> reply when the module's reload hook reported parts that did not reload (#529). The same text as the /ul reload summary line for such a module, whose key PluginManager declares.

See Also:

• Constant Field Values

Constructor Details

UltiToolsCommands

public UltiToolsCommands()

Method Details

reloadPlugins

public void reloadPlugins()

Reloads the framework and every module. /ul reload is handled by reloadAll(CommandSender) since 6.3.0, which also replies the reload summary to the sender (#509); this method is kept, unchanged, for any code that calls it directly.

reloadAll

public void reloadAll(org.bukkit.command.CommandSender sender)

/ul reload: reloads the framework and every module, each isolated from the others' failures, and replies the summary to the sender -- which modules failed, if any (#509).

Parameters:

sender - the command sender

reloadPlugin

public void reloadPlugin(org.bukkit.command.CommandSender sender,
 String name)

describeFailure

private static String describeFailure(Throwable failure)

A failure's message for a one-line reply, or its class name when it carries none.

Parameters:

failure - the failure to describe

Returns:

a non-null description

suggestModuleNames

public List<String> suggestModuleNames()

help

public void help(org.bukkit.command.CommandSender sender)

listPlugins

public void listPlugins(org.bukkit.command.CommandSender sender)

handleHelp

protected void handleHelp(org.bukkit.command.CommandSender sender)

Description copied from class: BaseCommandExecutor

Handles the help command. Override to provide custom help.

Specified by:

handleHelp in class BaseCommandExecutor

Parameters:

sender - the command sender