Class SingleCommand

java.lang.Object

me.lucko.luckperms.common.command.abstraction.Command<Void>

me.lucko.luckperms.common.command.abstraction.SingleCommand

Direct Known Subclasses:

ApplyEditsCommand, BulkUpdateCommand, CreateGroup, CreateTrack, DeleteGroup, DeleteTrack, EditorCommand, ExportCommand, ImportCommand, InfoCommand, ListGroups, ListTracks, NetworkSyncCommand, ReloadConfigCommand, SearchCommand, SyncCommand, TranslationsCommand, TreeCommand, TrustEditorCommand, VerboseCommand

public abstract class SingleCommand
extends Command<Void>

Represents a single "main" command (one without any children)

Constructor Summary

Constructors

Constructor	Description
SingleCommand(CommandSpec spec, String name, CommandPermission permission, Predicate<Integer> argumentCheck)

Method Summary

Modifier and Type	Method	Description
final void	execute(LuckPermsPlugin plugin, Sender sender, Void ignored, ArgumentList args, String label)
abstract void	execute(LuckPermsPlugin plugin, Sender sender, ArgumentList args, String label)
void	sendDetailedUsage(Sender sender, String label)	Sends a detailed command usage message to the Sender.
void	sendUsage(Sender sender, String label)	Sends a brief command usage message to the Sender.

Methods inherited from class Command

getArgs, getArgumentCheck, getDescription, getName, getPermission, getSpec, getUsage, isAuthorized, shouldDisplay, tabComplete

Methods inherited from class Object

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

Constructor Details

SingleCommand

public SingleCommand(CommandSpec spec,
 String name,
 CommandPermission permission,
 Predicate<Integer> argumentCheck)

Method Details

execute

public final void execute(LuckPermsPlugin plugin,
 Sender sender,
 Void ignored,
 ArgumentList args,
 String label)
                   throws CommandException

Specified by:

execute in class Command<Void>

Throws:

CommandException

execute

public abstract void execute(LuckPermsPlugin plugin,
 Sender sender,
 ArgumentList args,
 String label)
                      throws CommandException

Throws:

CommandException

sendUsage

public void sendUsage(Sender sender,
 String label)

Description copied from class: Command

Sends a brief command usage message to the Sender. If this command has child commands, the children are listed. Otherwise, a basic usage message is sent.

Specified by:

sendUsage in class Command<Void>

Parameters:

sender - the sender to send the usage to

label - the label used when executing the command

sendDetailedUsage

public void sendDetailedUsage(Sender sender,
 String label)

Description copied from class: Command

Sends a detailed command usage message to the Sender. If this command has child commands, nothing is sent. Otherwise, a detailed messaging containing a description and argument usage is sent.

Specified by:

sendDetailedUsage in class Command<Void>

Parameters:

sender - the sender to send the usage to

label - the label used when executing the command