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

Inheritance diagram for dev.jorel.commandapi.AbstractCommandTree< Impl, Argument, CommandSender >:

Public Member Functions
Impl	then (final AbstractArgumentTree<?, Argument, CommandSender > tree)
	Create a child branch on the tree. More...

final Impl	thenNested (List< AbstractArgumentTree<?, Argument, CommandSender > > trees)
	Creates a chain of child branches starting at this node. More...

final Impl	thenNested (final AbstractArgumentTree<?, Argument, CommandSender >... trees)
	Creates a chain of child branches starting at this node. More...

void	register (String namespace)
	Registers the command with a given namespace. More...

String	getName ()
	Returns the name of this command. More...

Impl	withPermission (CommandPermission permission)
	Applies a permission to the current command builder. More...

Impl	withPermission (String permission)
	Applies a permission to the current command builder. More...

Impl	withoutPermission (CommandPermission permission)
	Applies a permission to the current command builder. More...

Impl	withoutPermission (String permission)
	Applies a permission to the current command builder. More...

Impl	withRequirement (Predicate< CommandSender > requirement)
	Adds a requirement that has to be satisfied to use this command. More...

Impl	withAliases (String... aliases)
	Adds an array of aliases to the current command builder. More...

CommandPermission	getPermission ()
	Returns the permission associated with this command. More...

void	setPermission (CommandPermission permission)
	Sets the permission required to run this command. More...

String[]	getAliases ()
	Returns an array of aliases that can be used to run this command. More...

void	setAliases (String[] aliases)
	Sets the aliases for this command. More...

Predicate< CommandSender >	getRequirements ()
	Returns the requirements that must be satisfied to run this command. More...

void	setRequirements (Predicate< CommandSender > requirements)
	Sets the requirements that must be satisfied to run this command. More...

String	getShortDescription ()
	Returns the short description for this command. More...

Impl	withShortDescription (String description)
	Sets the short description for this command. More...

String	getFullDescription ()
	Returns the full description for this command. More...

Impl	withFullDescription (String description)
	Sets the full description for this command. More...

Impl	withUsage (String... usage)
	Sets the full usage for this command. More...

String[]	getUsage ()
	Returns the usage for this command. More...

Impl	withHelp (String shortDescription, String fullDescription)
	Sets the short and full description for this command. More...

void	override ()
	Overrides a command. More...

void	register ()
	Registers this command with the default namespace.

CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > >	getExecutor ()
	Returns the executors that this command has. More...

void	setExecutor (CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > > executor)
	Sets the executors for this command. More...

Impl	clearExecutors ()
	Clear all executors from the current command builder. More...

Impl	instance ()
	Returns the instance of this class with the class Impl. More...

Protected Member Functions
	AbstractCommandTree (final String commandName)
	Creates a main root node for a command tree with a given command name. More...

Protected Attributes
final CommandMetaData< CommandSender >	meta
	The Command's meta-data for this executable command.

CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > >	executor = new CommandAPIExecutor<>()
	The CommandAPIExecutor for this executable implementation.

Detailed Description

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

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

Constructor & Destructor Documentation

◆ AbstractCommandTree()

dev.jorel.commandapi.AbstractCommandTree< Impl, Argument, CommandSender >.AbstractCommandTree ( final String commandName )

protected

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

Parameters

commandName The name of the command to create

Member Function Documentation

◆ clearExecutors()

Impl dev.jorel.commandapi.Executable< Impl, CommandSender >.clearExecutors ( )

inherited

Clear all executors from the current command builder.

Returns: this command builder

◆ getAliases()

String[] dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getAliases ( )

inherited

Returns an array of aliases that can be used to run this command.

Returns: an array of aliases that can be used to run this command

◆ getExecutor()

CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > > dev.jorel.commandapi.Executable< Impl, CommandSender >.getExecutor ( )

inherited

Returns the executors that this command has.

Returns: the executors that this command has

◆ getFullDescription()

String dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getFullDescription ( )

inherited

Returns the full description for this command.

Returns: the full description for this command

◆ getName()

String dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getName ( )

inherited

Returns the name of this command.

Returns: the name of this command

◆ getPermission()

CommandPermission dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getPermission ( )

inherited

Returns the permission associated with this command.

Returns: the permission associated with this command

◆ getRequirements()

Predicate< CommandSender > dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getRequirements ( )

inherited

Returns the requirements that must be satisfied to run this command.

Returns: the requirements that must be satisfied to run this command

◆ getShortDescription()

String dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getShortDescription ( )

inherited

Returns the short description for this command.

Returns: the short description for this command

◆ getUsage()

String[] dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getUsage ( )

inherited

Returns the usage for this command.

Returns: the usage for this command

◆ instance()

Impl dev.jorel.commandapi.ChainableBuilder< Impl >.instance ( )

inherited

Returns the instance of this class with the class Impl.

Used for chaining builder methods.

Implemented in dev.jorel.commandapi.arguments.Argument< T >.

◆ override()

void dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.override ( )

inherited

Overrides a command.

Effectively the same as unregistering the command using CommandAPI.unregister() and then registering the command using .register()

◆ register()

void dev.jorel.commandapi.AbstractCommandTree< Impl, Argument, CommandSender >.register ( String namespace )

Registers the command with a given namespace.

Parameters

namespace The namespace of this command. This cannot be null

Exceptions

NullPointerException if the namespace is null

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

◆ setAliases()

void dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.setAliases ( String[] aliases )

inherited

Sets the aliases for this command.

Parameters

aliases the aliases for this command

◆ setExecutor()

void dev.jorel.commandapi.Executable< Impl, CommandSender >.setExecutor ( CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > > executor )

inherited

Sets the executors for this command.

Parameters

executor the executors for this command

◆ setPermission()

void dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.setPermission ( CommandPermission permission )

inherited

Sets the permission required to run this command.

Parameters

permission the permission required to run this command

◆ setRequirements()

void dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.setRequirements ( Predicate< CommandSender > requirements )

inherited

Sets the requirements that must be satisfied to run this command.

Parameters

requirements the requirements that must be satisfied to run this command

◆ then()

Impl dev.jorel.commandapi.AbstractCommandTree< Impl, Argument, CommandSender >.then ( final AbstractArgumentTree<?, Argument, CommandSender > tree )

Create a child branch on the tree.

Parameters

tree	the child node

Returns: this root node

◆ thenNested() [1/2]

final Impl dev.jorel.commandapi.AbstractCommandTree< Impl, Argument, CommandSender >.thenNested ( final AbstractArgumentTree<?, Argument, CommandSender >... trees )

Creates a chain of child branches starting at this node.

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

Parameters

trees The child branches to add in a chain.

Returns: this tree node

◆ thenNested() [2/2]

final Impl dev.jorel.commandapi.AbstractCommandTree< Impl, Argument, CommandSender >.thenNested ( List< AbstractArgumentTree<?, Argument, CommandSender > > trees )

Creates a chain of child branches starting at this node.

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

Parameters

trees The child branches to add in a chain.

Returns: this tree node

◆ withAliases()

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withAliases ( String... aliases )

inherited

Adds an array of aliases to the current command builder.

Parameters

aliases An array of aliases which can be used to execute this command

Returns: this command builder

◆ withFullDescription()

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withFullDescription ( String description )

inherited

Sets the full description for this command.

This is the help which is shown in the specific /help page for this command (e.g. /help mycommand).

Parameters

description the full description for this command

Returns: this command builder

◆ withHelp()

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withHelp	(	String	shortDescription,
		String	fullDescription
	)

inherited

Sets the short and full description for this command.

This is a short-hand for the ExecutableCommand#withShortDescription and ExecutableCommand#withFullDescription methods.

Parameters

shortDescription	the short description for this command
fullDescription	the full description for this command

Returns: this command builder

◆ withoutPermission() [1/2]

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withoutPermission ( CommandPermission permission )

inherited

Applies a permission to the current command builder.

Parameters

permission The permission node required to execute this command

Returns: this command builder

◆ withoutPermission() [2/2]

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withoutPermission ( String permission )

inherited

Applies a permission to the current command builder.

Parameters

permission The permission node required to execute this command

Returns: this command builder

◆ withPermission() [1/2]

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withPermission ( CommandPermission permission )

inherited

Applies a permission to the current command builder.

Parameters

permission The permission node required to execute this command

Returns: this command builder

◆ withPermission() [2/2]

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withPermission ( String permission )

inherited

Applies a permission to the current command builder.

Parameters

permission The permission node required to execute this command

Returns: this command builder

◆ withRequirement()

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withRequirement ( Predicate< CommandSender > requirement )

inherited

Adds a requirement that has to be satisfied to use this command.

This method can be used multiple times and each use of this method will AND its requirement with the previously declared ones

Parameters

requirement the predicate that must be satisfied to use this command

Returns: this command builder

◆ withShortDescription()

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withShortDescription ( String description )

inherited

Sets the short description for this command.

This is the help which is shown in the main /help menu.

Parameters

description the short description for this command

Returns: this command builder

◆ withUsage()

Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withUsage ( String... usage )

inherited

Sets the full usage for this command.

This is the usage which is shown in the specific /help page for this command (e.g. /help mycommand).

Parameters

usage the full usage for this command

Returns: this command builder

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractCommandTree()

Member Function Documentation

◆ clearExecutors()

◆ getAliases()

◆ getExecutor()

◆ getFullDescription()

◆ getName()

◆ getPermission()

◆ getRequirements()

◆ getShortDescription()

◆ getUsage()

◆ instance()

◆ override()

◆ register()

◆ setAliases()

◆ setExecutor()

◆ setPermission()

◆ setRequirements()

◆ then()

◆ thenNested() [1/2]

◆ thenNested() [2/2]

◆ withAliases()

◆ withFullDescription()

◆ withHelp()

◆ withoutPermission() [1/2]

◆ withoutPermission() [2/2]

◆ withPermission() [1/2]

◆ withPermission() [2/2]

◆ withRequirement()

◆ withShortDescription()

◆ withUsage()