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

java.lang.Object

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

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

Type Parameters:

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

Argument - The implementation of AbstractArgument used by the class extending this class

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

All Implemented Interfaces:

ChainableBuilder<Impl>

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

A builder used to create commands to be registered by the CommandAPI.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Argument>	arguments
protected CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>	executor	The CommandAPIExecutor for this executable implementation
protected boolean	isConverted
protected String	namespace
protected List<Impl>	subcommands

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	AbstractCommandAPICommand(dev.jorel.commandapi.CommandMetaData<CommandSender> metaData)	Creates a new Command builder
protected	AbstractCommandAPICommand(String commandName)	Creates a new command builder

Method Summary

Modifier and Type	Method	Description
Impl	clearExecutors()	Clear all executors from the current command builder
Impl	copy()
List<Argument>	getArguments()	Returns the list of arguments that this command has
CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>	getExecutor()	Returns the executors that this command has
List<Impl>	getSubcommands()	Returns the list of subcommands that this command has
boolean	isConverted()	Returns whether this command is an automatically converted command
protected abstract Impl	newConcreteCommandAPICommand(dev.jorel.commandapi.CommandMetaData<CommandSender> metaData)
void	register(String namespace)	Registers the command with a given namespace
void	setArguments(List<Argument> args)	Sets the arguments that this command has
void	setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>> executor)	Sets the executors for this command
void	setSubcommands(List<Impl> subcommands)	Sets the list of subcommands that this command has
final Impl	withArguments(Argument... args)	Appends the argument(s) to the current command builder
Impl	withArguments(List<Argument> args)	Appends the arguments to the current command builder
final Impl	withOptionalArguments(Argument... args)	Appends the optional arguments to the current command builder.
Impl	withOptionalArguments(List<Argument> args)	Appends the optional arguments to the current command builder.
Impl	withSubcommand(Impl subcommand)	Adds a subcommand to this command builder
Impl	withSubcommands(Impl... subcommands)	Adds subcommands to this command builder

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

arguments

protected List<Argument extends AbstractArgument<?, ?, Argument, CommandSender>> arguments

subcommands

protected List<Impl extends AbstractCommandAPICommand<Impl, Argument, CommandSender>> subcommands

isConverted

protected boolean isConverted

namespace

protected String namespace

executor

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

The CommandAPIExecutor for this executable implementation

Constructor Details

AbstractCommandAPICommand

protected AbstractCommandAPICommand(String commandName)

Creates a new command builder

Parameters:

commandName - The name of the command to create

AbstractCommandAPICommand

protected AbstractCommandAPICommand(dev.jorel.commandapi.CommandMetaData<CommandSender> metaData)

Creates a new Command builder

Parameters:

metaData - The metadata of the command to create

Method Details

withArguments

public Impl withArguments(List<Argument> args)

Appends the arguments to the current command builder

Parameters:

args - A List that represents the arguments that this command can accept

Returns:

this command builder

withArguments

@SafeVarargs
public final Impl withArguments(Argument... args)

Appends the argument(s) to the current command builder

Parameters:

args - Arguments that this command can accept

Returns:

this command builder

withOptionalArguments

public Impl withOptionalArguments(List<Argument> args)

Appends the optional arguments to the current command builder.

This also calls AbstractArgument.setOptional(boolean) on each argument to make sure they are optional

Parameters:

args - A List that represents the arguments that this command can accept

Returns:

this command builder

withOptionalArguments

@SafeVarargs
public final Impl withOptionalArguments(Argument... args)

Appends the optional arguments to the current command builder.

This also calls AbstractArgument.setOptional(boolean) on each argument to make sure they are optional

Parameters:

args - Arguments that this command can accept

Returns:

this command builder

withSubcommand

public Impl withSubcommand(Impl subcommand)

Adds a subcommand to this command builder

Parameters:

subcommand - the subcommand to add as a child of this command

Returns:

this command builder

withSubcommands

public Impl withSubcommands(Impl... subcommands)

Adds subcommands to this command builder

Parameters:

subcommands - the subcommands to add as children of this command

Returns:

this command builder

getArguments

public List<Argument> getArguments()

Returns the list of arguments that this command has

Returns:

the list of arguments that this command has

setArguments

public void setArguments(List<Argument> args)

Sets the arguments that this command has

Parameters:

args - the arguments that this command has

getSubcommands

public List<Impl> getSubcommands()

Returns the list of subcommands that this command has

Returns:

the list of subcommands that this command has

setSubcommands

public void setSubcommands(List<Impl> subcommands)

Sets the list of subcommands that this command has

Parameters:

subcommands - the list of subcommands that this command has

isConverted

public boolean isConverted()

Returns whether this command is an automatically converted command

Returns:

whether this command is an automatically converted command

register

public void register(String namespace)

Registers the command with a given namespace

Specified by:

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

Parameters:

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

Throws:

NullPointerException - if the namespace is null

copy

public Impl copy()

newConcreteCommandAPICommand

protected abstract Impl newConcreteCommandAPICommand(dev.jorel.commandapi.CommandMetaData<CommandSender> metaData)

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