Package wbs.utils.util.commands

Class WbsCommandNode

java.lang.Object

wbs.utils.util.plugin.WbsMessenger

wbs.utils.util.commands.WbsSubcommand

wbs.utils.util.commands.WbsCommandNode

public abstract class WbsCommandNode
extends WbsSubcommand

An implementation of WbsSubcommand that simply passes the command to a given subcommand, including tabbing, or provides default usage messages when no args or incorrect args are given.

Field Summary

Fields inherited from class wbs.utils.util.plugin.WbsMessenger

plugin

Constructor Summary

Constructors

Constructor	Description
WbsCommandNode(WbsPlugin plugin, String label)

Method Summary

Modifier and Type	Method	Description
void	addChild(WbsSubcommand subcommand)	Adds a child subcommand
void	addChild(WbsSubcommand subcommand, String permission)	Adds a child permission and automatically sets the permission for that subcommand
protected int	getArgLength()
List<String>	getSubcommandLabels(org.bukkit.command.CommandSender sender)	Gets a list of all labels for subcommands usable by the given sender
List<String>	getTabCompletions(@NotNull org.bukkit.command.CommandSender sender, @NotNull String label, @NotNull String[] args, int start)
protected final boolean	onCommand(@NotNull org.bukkit.command.CommandSender sender, @NotNull String label, @NotNull String[] args)	Theoretically should never be called, only being implemented here since the start version is implemented, and implementing subclasses shouldn't be able to implement this (as they might expect it to be called).
protected boolean	onCommand(@NotNull org.bukkit.command.CommandSender sender, @NotNull String label, @NotNull String[] args, int start)	Run this subcommand for the given sender, starting at arg[start].
protected boolean	onCommandNoArgs(@NotNull org.bukkit.command.CommandSender sender, @NotNull String label, @NotNull String[] args, int start)

Methods inherited from class wbs.utils.util.commands.WbsSubcommand

addAlias, addAliases, getAliases, getLabel, getPermission, getTabCompletions, isAliased, onCommandCheckPermission, sendUsage, sendUsage, setAliases, setPermission

Methods inherited from class wbs.utils.util.plugin.WbsMessenger

broadcast, broadcastActionBar, checkPermission, sendActionBar, sendList, sendList, sendMessage, sendMessageNoPrefix

Methods inherited from class java.lang.Object

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

Constructor Details

WbsCommandNode

public WbsCommandNode(WbsPlugin plugin,
 String label)

Parameters:

plugin - The WbsPlugin

label - The label for this node

Method Details

addChild

public void addChild(WbsSubcommand subcommand)

Adds a child subcommand

Parameters:

subcommand - The child subcommand to pass to if the label is given

addChild

public void addChild(WbsSubcommand subcommand,
 String permission)

Adds a child permission and automatically sets the permission for that subcommand

Parameters:

subcommand - The child subcommand to pass to if the label is given

permission - The permission to apply to the child subcommand

onCommand

protected boolean onCommand(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull String label,
 @NotNull
 @NotNull String[] args,
 int start)

Description copied from class: WbsSubcommand

Run this subcommand for the given sender, starting at arg[start]. When this is called, the permission has already been checked.

Overrides:

onCommand in class WbsSubcommand

Parameters:

sender - The sender that ran the command

label - The alias used to run this command

args - The arguments provided

Returns:

false if the command failed unexpectedly, true otherwise

onCommand

protected final boolean onCommand(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull String label,
 @NotNull
 @NotNull String[] args)

Theoretically should never be called, only being implemented here since the start version is implemented, and implementing subclasses shouldn't be able to implement this (as they might expect it to be called).

Overrides:

onCommand in class WbsSubcommand

Parameters:

sender - The sender that ran the command

label - The alias used to run this command

args - The arguments provided

Returns:

false if the command failed unexpectedly, true otherwise

onCommandNoArgs

protected boolean onCommandNoArgs(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull String label,
 @NotNull
 @NotNull String[] args,
 int start)

getTabCompletions

public List<String> getTabCompletions(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull String label,
 @NotNull
 @NotNull String[] args,
 int start)

Overrides:

getTabCompletions in class WbsSubcommand

getSubcommandLabels

public List<String> getSubcommandLabels(org.bukkit.command.CommandSender sender)

Gets a list of all labels for subcommands usable by the given sender

Parameters:

sender - The sender to filter by

Returns:

The list of labels for subcommands usable by the sender

getArgLength

protected int getArgLength()

Returns:

The number of arguments this node will process before handing off to the child