Package com.earth2me.essentials.commands

Class EssentialsCommand

java.lang.Object

com.earth2me.essentials.commands.EssentialsCommand

All Implemented Interfaces:

IEssentialsCommand

Direct Known Subclasses:

Commandafk, Commandantioch, Commandanvil, Commandback, Commandbackup, Commandbalance, Commandbalancetop, Commandban, Commandbanip, Commandbeezooka, Commandbigtree, Commandbook, Commandbottom, Commandbreak, Commandbroadcast, Commandbroadcastworld, Commandburn, Commandcartographytable, Commandclearinventory, Commandclearinventoryconfirmtoggle, Commandcompass, Commandcondense, Commandcreatekit, Commandcustomtext, Commanddelhome, Commanddeljail, Commanddelkit, Commanddelwarp, Commanddepth, Commanddisposal, Commandeditsign, Commandenchant, Commandenderchest, Commandessentials, Commandfireball, Commandfirework, Commandgc, Commandgetpos, Commandgrindstone, Commandhat, Commandhelp, Commandhelpop, Commandhome, Commandignore, Commandinfo, Commandinvsee, Commanditem, Commanditemdb, Commanditemlore, Commanditemname, Commandjails, Commandjump, Commandkick, Commandkickall, Commandkit, Commandkitreset, Commandkittycannon, Commandlist, Commandloom, Commandmail, Commandme, Commandmore, Commandmotd, Commandmute, Commandnear, Commandnuke, Commandpayconfirmtoggle, Commandping, Commandplaytime, Commandpotion, Commandpowertool, Commandpowertooltoggle, Commandr, Commandrealname, Commandrecipe, Commandremove, Commandrenamehome, Commandrepair, Commandrules, Commandseen, Commandsell, Commandsethome, Commandsetjail, Commandsettpr, Commandsetwarp, Commandsetworth, Commandshowkit, Commandskull, Commandsmithingtable, Commandspawner, Commandspawnmob, Commandspeed, Commandstonecutter, Commandsuicide, Commandtempban, Commandtempbanip, Commandthunder, Commandtime, Commandtogglejail, Commandtop, Commandtp, Commandtpa, Commandtpaall, Commandtpacancel, Commandtpaccept, Commandtpahere, Commandtpall, Commandtpdeny, Commandtphere, Commandtpo, Commandtpoffline, Commandtpohere, Commandtppos, Commandtpr, Commandtree, Commandunban, Commandunbanip, Commandunlimited, Commandwarp, Commandwarpinfo, Commandweather, Commandwhois, Commandworkbench, Commandworld, Commandworth, EssentialsLoopCommand, EssentialsToggleCommand

public abstract class EssentialsCommand
extends Object
implements IEssentialsCommand

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	COMMON_DATE_DIFFS	Common date diffs, for use in tab completion
protected static final List<String>	COMMON_DURATIONS	Common time durations (in seconds), for use in tab completion.
protected IEssentials	ess
protected IEssentialsModule	module

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EssentialsCommand(String name)

Method Summary

Modifier and Type	Method	Description
protected final List<String>	getCommands(Server server)	Lists all commands.
static String	getFinalArg(String[] args, int start)
protected List<String>	getItems()	Gets a list of tab-completable items that start with the given name.
protected List<String>	getMatchingItems(String arg)	Gets a list of tab-completable items usable for "getMatching".
String	getName()
CompletableFuture<Boolean>	getNewExceptionFuture(CommandSource sender, String commandLabel)
protected User	getPlayer(Server server, CommandSource sender, String searchTerm)
protected User	getPlayer(Server server, CommandSource sender, String[] args, int pos)
protected User	getPlayer(Server server, CommandSource sender, String[] args, int pos, boolean getOffline)
protected User	getPlayer(Server server, User user, String[] args, int pos)
protected User	getPlayer(Server server, User user, String[] args, int pos, boolean getOffline)
protected User	getPlayer(Server server, String[] args, int pos, boolean getHidden, boolean getOffline)
protected User	getPlayer(Server server, String searchTerm, boolean getHidden, boolean getOffline)
protected List<String>	getPlayers(Server server, CommandSource interactor)	Gets a list of all player names that can be seen with by the given CommandSource, for tab completion.
protected List<String>	getPlayers(Server server, User interactor)	Gets a list of all player names that can be seen with by the given User, for tab completion.
protected final List<String>	getPlugins(Server server)	Lists all plugin names
protected List<String>	getTabCompleteOptions(Server server, CommandSource sender, String commandLabel, String[] args)
protected List<String>	getTabCompleteOptions(Server server, User user, String commandLabel, String[] args)
Map<String,String>	getUsageStrings()
protected void	run(Server server, CommandSource sender, String commandLabel, String[] args)
final void	run(Server server, CommandSource sender, String commandLabel, Command cmd, String[] args)
protected void	run(Server server, User user, String commandLabel, String[] args)
final void	run(Server server, User user, String commandLabel, Command cmd, String[] args)
void	setEssentials(IEssentials ess)
void	setEssentialsModule(IEssentialsModule module)
void	showError(CommandSender sender, Throwable throwable, String commandLabel)
final List<String>	tabComplete(Server server, CommandSource sender, String commandLabel, Command cmd, String[] args)
final List<String>	tabComplete(Server server, User user, String commandLabel, Command cmd, String[] args)
protected final List<String>	tabCompleteCommand(CommandSource sender, Server server, String label, String[] args, int index)	Attempts to tab-complete a command or its arguments.

Methods inherited from class java.lang.Object

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

Field Details

COMMON_DURATIONS

protected static final List<String> COMMON_DURATIONS

Common time durations (in seconds), for use in tab completion.

COMMON_DATE_DIFFS

protected static final List<String> COMMON_DATE_DIFFS

Common date diffs, for use in tab completion

ess

protected transient IEssentials ess

module

protected transient IEssentialsModule module

Constructor Details

EssentialsCommand

protected EssentialsCommand(String name)

Method Details

getUsageStrings

public Map<String,String> getUsageStrings()

Specified by:

getUsageStrings in interface IEssentialsCommand

getFinalArg

public static String getFinalArg(String[] args,
 int start)

setEssentials

public void setEssentials(IEssentials ess)

Specified by:

setEssentials in interface IEssentialsCommand

setEssentialsModule

public void setEssentialsModule(IEssentialsModule module)

Specified by:

setEssentialsModule in interface IEssentialsCommand

getName

public String getName()

Specified by:

getName in interface IEssentialsCommand

getPlayer

protected User getPlayer(Server server,
 CommandSource sender,
 String[] args,
 int pos)
                  throws PlayerNotFoundException,
NotEnoughArgumentsException

Throws:

PlayerNotFoundException

NotEnoughArgumentsException

getPlayer

protected User getPlayer(Server server,
 CommandSource sender,
 String[] args,
 int pos,
 boolean getOffline)
                  throws PlayerNotFoundException,
NotEnoughArgumentsException

Throws:

PlayerNotFoundException

NotEnoughArgumentsException

getPlayer

protected User getPlayer(Server server,
 CommandSource sender,
 String searchTerm)
                  throws PlayerNotFoundException,
NotEnoughArgumentsException

Throws:

PlayerNotFoundException

NotEnoughArgumentsException

getPlayer

protected User getPlayer(Server server,
 User user,
 String[] args,
 int pos)
                  throws PlayerNotFoundException,
NotEnoughArgumentsException

Throws:

PlayerNotFoundException

NotEnoughArgumentsException

getPlayer

protected User getPlayer(Server server,
 User user,
 String[] args,
 int pos,
 boolean getOffline)
                  throws PlayerNotFoundException,
NotEnoughArgumentsException

Throws:

PlayerNotFoundException

NotEnoughArgumentsException

getPlayer

protected User getPlayer(Server server,
 String[] args,
 int pos,
 boolean getHidden,
 boolean getOffline)
                  throws PlayerNotFoundException,
NotEnoughArgumentsException

Throws:

PlayerNotFoundException

NotEnoughArgumentsException

getPlayer

protected User getPlayer(Server server,
 String searchTerm,
 boolean getHidden,
 boolean getOffline)
                  throws PlayerNotFoundException

Throws:

PlayerNotFoundException

run

public final void run(Server server,
 User user,
 String commandLabel,
 Command cmd,
 String[] args)
               throws Exception

Specified by:

run in interface IEssentialsCommand

Throws:

Exception

run

protected void run(Server server,
 User user,
 String commandLabel,
 String[] args)
            throws Exception

Throws:

Exception

run

public final void run(Server server,
 CommandSource sender,
 String commandLabel,
 Command cmd,
 String[] args)
               throws Exception

Specified by:

run in interface IEssentialsCommand

Throws:

Exception

run

protected void run(Server server,
 CommandSource sender,
 String commandLabel,
 String[] args)
            throws Exception

Throws:

Exception

tabComplete

public final List<String> tabComplete(Server server,
 User user,
 String commandLabel,
 Command cmd,
 String[] args)

Specified by:

tabComplete in interface IEssentialsCommand

getTabCompleteOptions

protected List<String> getTabCompleteOptions(Server server,
 User user,
 String commandLabel,
 String[] args)

tabComplete

public final List<String> tabComplete(Server server,
 CommandSource sender,
 String commandLabel,
 Command cmd,
 String[] args)

Specified by:

tabComplete in interface IEssentialsCommand

getTabCompleteOptions

protected List<String> getTabCompleteOptions(Server server,
 CommandSource sender,
 String commandLabel,
 String[] args)

getPlayers

protected List<String> getPlayers(Server server,
 CommandSource interactor)

Gets a list of all player names that can be seen with by the given CommandSource, for tab completion.

getPlayers

protected List<String> getPlayers(Server server,
 User interactor)

Gets a list of all player names that can be seen with by the given User, for tab completion.

getItems

protected List<String> getItems()

Gets a list of tab-completable items that start with the given name. Due to the number of items, this may not return the entire list.

getMatchingItems

protected List<String> getMatchingItems(String arg)

Gets a list of tab-completable items usable for "getMatching".

getCommands

protected final List<String> getCommands(Server server)

Lists all commands.

getPlugins

protected final List<String> getPlugins(Server server)

Lists all plugin names

Parameters:

server - Server instance

Returns:

List of plugin names

tabCompleteCommand

protected final List<String> tabCompleteCommand(CommandSource sender,
 Server server,
 String label,
 String[] args,
 int index)

Attempts to tab-complete a command or its arguments.

showError

public void showError(CommandSender sender,
 Throwable throwable,
 String commandLabel)

Specified by:

showError in interface IEssentialsCommand

getNewExceptionFuture

public CompletableFuture<Boolean> getNewExceptionFuture(CommandSource sender,
 String commandLabel)