Class AbstractCommandTree<Impl extends AbstractCommandTree<Impl, Argument, CommandSender>, Argument extends AbstractArgument<?, ?, Argument, CommandSender>, CommandSender>

java.lang.Object

dev.jorel.commandapi.ExecutableCommand<Impl, CommandSender>

dev.jorel.commandapi.AbstractCommandTree<Impl, Argument, CommandSender>

Type Parameters:

Impl - The class extending this class, used as the return type for chain calls

Argument - The implementation of AbstractArgument being used by this class

CommandSender - The CommandSender class used by the class extending this class

All Implemented Interfaces:

ChainableBuilder<Impl>

public abstract class AbstractCommandTree<Impl extends AbstractCommandTree<Impl, Argument, CommandSender>, Argument extends AbstractArgument<?, ?, Argument, CommandSender>, CommandSender>
extends ExecutableCommand<Impl, CommandSender>

This is the root node for creating a command as a tree

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>	executor	The CommandAPIExecutor for this executable implementation

Fields inherited from class ExecutableCommand

meta

Modifier and Type	Field	Description
protected final dev.jorel.commandapi.CommandMetaData<CommandSender>	meta	The Command's meta-data for this executable command

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCommandTree(String commandName)	Creates a main root node for a command tree with a given command name

Method Summary

Modifier and Type	Method	Description
Impl	clearExecutors()	Clear all executors from the current command builder
CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>	getExecutor()	Returns the executors that this command has
void	register(String namespace)	Registers the command with a given namespace
void	setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>> executor)	Sets the executors for this command
Impl	then(AbstractArgumentTree<?, Argument, CommandSender> tree)	Create a child branch on the tree
final Impl	thenNested(AbstractArgumentTree<?, Argument, CommandSender>... trees)	Creates a chain of child branches starting at this node
final Impl	thenNested(List<AbstractArgumentTree<?, Argument, CommandSender>> trees)	Creates a chain of child branches starting at this node

Methods inherited from class ExecutableCommand

getAliases, getFullDescription, getName, getPermission, getRequirements, getShortDescription, getUsage, override, register, setAliases, setPermission, setRequirements, withAliases, withFullDescription, withHelp, withoutPermission, withoutPermission, withPermission, withPermission, withRequirement, withShortDescription, withUsage

Modifier and Type	Method	Description
String[]	getAliases()	Returns an array of aliases that can be used to run this command
String	getFullDescription()	Returns the full description for this command
String	getName()	Returns the name of this command
CommandPermission	getPermission()	Returns the permission associated with this command
Predicate<CommandSender>	getRequirements()	Returns the requirements that must be satisfied to run this command
String	getShortDescription()	Returns the short description for this command
String[]	getUsage()	Returns the usage for this command
void	override()	Overrides a command.
void	register()	Registers this command with the default namespace
void	setAliases(String[] aliases)	Sets the aliases for this command
void	setPermission(CommandPermission permission)	Sets the permission required to run this command
void	setRequirements(Predicate<CommandSender> requirements)	Sets the requirements that must be satisfied to run this command
Impl	withAliases(String... aliases)	Adds an array of aliases to the current command builder
Impl	withFullDescription(String description)	Sets the full description for this command.
Impl	withHelp(String shortDescription, String fullDescription)	Sets the short and full description for this command.
Impl	withoutPermission(CommandPermission permission)	Applies a permission to the current command builder
Impl	withoutPermission(String permission)	Applies a permission to the current command builder
Impl	withPermission(CommandPermission permission)	Applies a permission to the current command builder
Impl	withPermission(String permission)	Applies a permission to the current command builder
Impl	withRequirement(Predicate<CommandSender> requirement)	Adds a requirement that has to be satisfied to use this command.
Impl	withShortDescription(String description)	Sets the short description for this command.
Impl	withUsage(String... usage)	Sets the full usage for this command.

Methods inherited from class Object

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

Methods inherited from interface ChainableBuilder

instance

Modifier and Type	Method	Description
Impl	instance()	Returns the instance of this class with the class Impl.

Field Details

executor

protected CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>> executor

The CommandAPIExecutor for this executable implementation

Constructor Details

AbstractCommandTree

protected AbstractCommandTree(String commandName)

Creates a main root node for a command tree with a given command name

Parameters:

commandName - The name of the command to create

Method Details

then

public Impl then(AbstractArgumentTree<?, Argument, CommandSender> tree)

Create a child branch on the tree

Parameters:

tree - the child node

Returns:

this root node

thenNested

public final Impl thenNested(List<AbstractArgumentTree<?, Argument, CommandSender>> trees)

Creates a chain of child branches starting at this node

thenNested(a, b, c) is equivalent to then(AbstractArgumentTree)(a.then(b.then(c))).

Parameters:

trees - The child branches to add in a chain.

Returns:

this tree node

thenNested

@SafeVarargs
public final Impl thenNested(AbstractArgumentTree<?, Argument, CommandSender>... trees)

Creates a chain of child branches starting at this node

thenNested(a, b, c) is equivalent to then(AbstractArgumentTree)(a.then(b.then(c))).

Parameters:

trees - The child branches to add in a chain.

Returns:

this tree node

register

public void register(String namespace)

Registers the command with a given namespace

Specified by:

register in class ExecutableCommand<Impl extends AbstractCommandTree<Impl, Argument, CommandSender>, CommandSender>

Parameters:

namespace - The namespace of this command. This cannot be null

Throws:

NullPointerException - if the namespace is null

getExecutor

public CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>> getExecutor()

Returns the executors that this command has

Returns:

the executors that this command has

setExecutor

public void setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>> executor)

Sets the executors for this command

Parameters:

executor - the executors for this command

clearExecutors

public Impl clearExecutors()

Clear all executors from the current command builder

Returns:

this command builder