Class ParentCommand<T,I>

java.lang.Object

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

me.lucko.luckperms.common.command.abstraction.ParentCommand<T,I>

Direct Known Subclasses:

GroupParentCommand, LogParentCommand, TrackParentCommand, UserParentCommand

public abstract class ParentCommand<T,I>
extends Command<Void>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ParentCommand.Type

Constructor Summary

Constructors

Constructor	Description
ParentCommand(CommandSpec spec, String name, ParentCommand.Type type, List<Command<T>> children)

Method Summary

Modifier and Type	Method	Description
protected void	cleanup(T t, LuckPermsPlugin plugin)
void	execute(LuckPermsPlugin plugin, Sender sender, Void ignored, ArgumentList args, String label)
@NonNull List<Command<T>>	getChildren()
protected ReentrantLock	getLockForTarget(I target)
protected T	getTarget(I target, LuckPermsPlugin plugin, Sender sender)
protected List<String>	getTargets(LuckPermsPlugin plugin)
boolean	isAuthorized(Sender sender)	Returns true if the sender is authorised to use this command Commands with children are likely to override this method to check for permissions based upon whether a sender has access to any sub commands.
protected I	parseTarget(String target, LuckPermsPlugin plugin, Sender sender)
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.
List<String>	tabComplete(LuckPermsPlugin plugin, Sender sender, ArgumentList args)

Methods inherited from class Command

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

Methods inherited from class Object

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

Constructor Details

ParentCommand

public ParentCommand(CommandSpec spec,
 String name,
 ParentCommand.Type type,
 List<Command<T>> children)

Method Details

getChildren

public @NonNull List<Command<T>> getChildren()

execute

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

Specified by:

execute in class Command<Void>

tabComplete

public List<String> tabComplete(LuckPermsPlugin plugin,
 Sender sender,
 ArgumentList args)

Overrides:

tabComplete in class Command<Void>

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

isAuthorized

public boolean isAuthorized(Sender sender)

Description copied from class: Command

Returns true if the sender is authorised to use this command Commands with children are likely to override this method to check for permissions based upon whether a sender has access to any sub commands.

Overrides:

isAuthorized in class Command<Void>

Parameters:

sender - the sender

Returns:

true if the sender has permission to use this command

getTargets

protected List<String> getTargets(LuckPermsPlugin plugin)

parseTarget

protected I parseTarget(String target,
 LuckPermsPlugin plugin,
 Sender sender)

getLockForTarget

protected ReentrantLock getLockForTarget(I target)

getTarget

protected T getTarget(I target,
 LuckPermsPlugin plugin,
 Sender sender)

cleanup

protected void cleanup(T t,
 LuckPermsPlugin plugin)