dev.jorel.commandapi.CommandAPICommand Class Reference

Inheritance diagram for dev.jorel.commandapi.CommandAPICommand:

Public Member Functions
	CommandAPICommand (CommandMetaData< CommandSender > meta)
	CommandAPICommand (String commandName)
CommandAPICommand	instance ()
CommandAPICommand	withHelp (HelpTopic helpTopic)
	Sets the HelpTopic for this command. More...
void	register (String namespace)
	Registers the command with a given namespace. More...
void	register (JavaPlugin plugin)
	Registers this command with a given JavaPlugin instance. More...
boolean	isConverted ()
	Returns whether this command is an automatically converted command. More...
Impl	withArguments (List< Argument > args)
	Appends the arguments to the current command builder. More...
final Impl	withArguments (Argument... args)
	Appends the argument(s) to the current command builder. More...
Impl	withOptionalArguments (List< Argument > args)
	Appends the optional arguments to the current command builder. More...
final Impl	withOptionalArguments (Argument... args)
	Appends the optional arguments to the current command builder. More...
Impl	withSubcommand (Impl subcommand)
	Adds a subcommand to this command builder. More...
Impl	withSubcommands ( @SuppressWarnings("unchecked") Impl... subcommands)
	Adds subcommands to this command builder. More...
List< Argument >	getArguments ()
	Returns the list of arguments that this command has. More...
void	setArguments (List< Argument > args)
	Sets the arguments that this command has. More...
List< Impl >	getSubcommands ()
	Returns the list of subcommands that this command has. More...
void	setSubcommands (List< Impl > subcommands)
	Sets the list of subcommands that this command has. More...
Impl	copy ()
default Impl	executes (CommandExecutor executor, ExecutorType... types)
	Adds an executor to the current command builder. More...
default Impl	executes (CommandExecutionInfo executor, ExecutorType... types)
	Adds an executor to the current command builder. More...
default Impl	executes (ResultingCommandExecutor executor, ExecutorType... types)
	Adds an executor to the current command builder. More...
default Impl	executes (ResultingCommandExecutionInfo executor, ExecutorType... types)
	Adds an executor to the current command builder. More...
default Impl	executesPlayer (PlayerCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesPlayer (PlayerExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesPlayer (PlayerResultingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesPlayer (PlayerResultingExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesEntity (EntityCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesEntity (EntityExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesEntity (EntityResultingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesEntity (EntityResultingExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesProxy (ProxyCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesProxy (ProxyExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesProxy (ProxyResultingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesProxy (ProxyResultingExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesCommandBlock (CommandBlockCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesCommandBlock (CommandBlockExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesCommandBlock (CommandBlockResultingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesCommandBlock (CommandBlockResultingExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesConsole (ConsoleCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesConsole (ConsoleExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesConsole (ConsoleResultingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesConsole (ConsoleResultingExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesNative (NativeCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesNative (NativeExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesNative (NativeResultingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesNative (NativeResultingExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesRemoteConsole (RemoteConsoleCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesRemoteConsole (RemoteConsoleExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesRemoteConsole (RemoteConsoleResultingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesRemoteConsole (RemoteConsoleResultingExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesFeedbackForwarding (FeedbackForwardingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesFeedbackForwarding (FeedbackForwardingExecutionInfo info)
	Adds an executor to the current command builder. More...
default Impl	executesFeedbackForwarding (FeedbackForwardingResultingCommandExecutor executor)
	Adds an executor to the current command builder. More...
default Impl	executesFeedbackForwarding (FeedbackForwardingResultingExecutionInfo info)
	Adds an executor to the current command builder. More...

Protected Member Functions
CommandAPICommand	newConcreteCommandAPICommand (CommandMetaData< CommandSender > metaData)

Protected Attributes
List< Argument >	arguments
List< Impl >	subcommands
boolean	isConverted

Member Function Documentation

executes() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executes ( CommandExecutionInfo  executor, ExecutorType...  types  )

inherited

Adds an executor to the current command builder.

Parameters

executor	A lambda of type (BukkitCommandExecutionInfo) -> () that will be executed when the command is run
types	A list of executor types to use this executes method for.

Returns

this command builder

executes() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executes ( CommandExecutor  executor, ExecutorType...  types  )

inherited

Adds an executor to the current command builder.

Parameters

executor	A lambda of type (CommandSender, Object[]) -> () that will be executed when the command is run
types	A list of executor types to use this executes method for.

Returns

this command builder

executes() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executes ( ResultingCommandExecutionInfo  executor, ExecutorType...  types  )

inherited

Adds an executor to the current command builder.

Parameters

executor	A lambda of type (BukkitCommandExecutionInfo) -> int that will be executed when the command is run
types	A list of executor types to use this executes method for.

Returns

this command builder

executes() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executes ( ResultingCommandExecutor  executor, ExecutorType...  types  )

inherited

Adds an executor to the current command builder.

Parameters

executor	A lambda of type (CommandSender, CommandArguments) -> int that will be executed when the command is run
types	A list of executor types to use this executes method for.

Returns

this command builder

executesCommandBlock() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesCommandBlock ( CommandBlockCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (BlockCommandSender, CommandArguments) -> () that will be executed when the command is run

Returns

this command builder

executesCommandBlock() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesCommandBlock ( CommandBlockExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> () that will be executed when the command is run

Returns

this command builder

executesCommandBlock() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesCommandBlock ( CommandBlockResultingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (BlockCommandSender, CommandArguments) -> int that will be executed when the command is run

Returns

this command builder

executesCommandBlock() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesCommandBlock ( CommandBlockResultingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> int that will be executed when the command is run

Returns

this command builder

executesConsole() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesConsole ( ConsoleCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (ConsoleCommandSender, CommandArguments) -> () that will be executed when the command is run

Returns

this command builder

executesConsole() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesConsole ( ConsoleExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> () that will be executed when the command is run

Returns

this command builder

executesConsole() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesConsole ( ConsoleResultingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (ConsoleCommandSender, CommandArguments) -> int that will be executed when the command is run

Returns

this command builder

executesConsole() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesConsole ( ConsoleResultingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> int that will be executed when the command is run

Returns

this command builder

executesEntity() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesEntity ( EntityCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (Entity, CommandArguments) -> () that will be executed when the command is run

Returns

this command builder

executesEntity() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesEntity ( EntityExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> () that will be executed when the command is run

Returns

this command builder

executesEntity() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesEntity ( EntityResultingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (Entity, CommandArguments) -> int that will be executed when the command is run

Returns

this command builder

executesEntity() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesEntity ( EntityResultingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> int that will be executed when the command is run

Returns

this command builder

executesFeedbackForwarding() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesFeedbackForwarding ( FeedbackForwardingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (FeedbackForwardingCommandExecutor, CommandArguments) -> () that will be executed when the command is run

Returns

this command builder

executesFeedbackForwarding() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesFeedbackForwarding ( FeedbackForwardingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> () that will be executed when the command is run

Returns

this command builder

executesFeedbackForwarding() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesFeedbackForwarding ( FeedbackForwardingResultingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (FeedbackForwardingCommandExecutor, CommandArguments) -> int that will be executed when the command is run

Returns

this command builder

executesFeedbackForwarding() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesFeedbackForwarding ( FeedbackForwardingResultingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> int that will be executed when the command is run

Returns

this command builder

executesNative() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesNative ( NativeCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (NativeCommandExecutor, CommandArguments) -> () that will be executed when the command is run

Returns

this command builder

executesNative() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesNative ( NativeExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> () that will be executed when the command is run

Returns

this command builder

executesNative() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesNative ( NativeResultingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (NativeCommandExecutor, CommandArguments) -> int that will be executed when the command is run

Returns

this command builder

executesNative() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesNative ( NativeResultingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> int that will be executed when the command is run

Returns

this command builder

executesPlayer() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesPlayer ( PlayerCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (Player, CommandArguments) -> () that will be executed when the command is run

Returns

this command builder

executesPlayer() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesPlayer ( PlayerExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> () that will be executed when the command is run

Returns

this command builder

executesPlayer() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesPlayer ( PlayerResultingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (Player, CommandArguments) -> int that will be executed when the command is run

Returns

this command builder

executesPlayer() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesPlayer ( PlayerResultingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> int that will be executed when the command is run

Returns

this command builder

executesProxy() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesProxy ( ProxyCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (Entity, CommandArguments) -> () that will be executed when the command is run

Returns

this command builder

executesProxy() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesProxy ( ProxyExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> () that will be executed when the command is run

Returns

this command builder

executesProxy() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesProxy ( ProxyResultingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (Entity, CommandArguments) -> int that will be executed when the command is run

Returns

this command builder

executesProxy() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesProxy ( ProxyResultingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> int that will be executed when the command is run

Returns

this command builder

executesRemoteConsole() [1/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesRemoteConsole ( RemoteConsoleCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (RemoteConsoleCommandExecutor, CommandArguments) -> () that will be executed when the command is run

Returns

this command builder

executesRemoteConsole() [2/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesRemoteConsole ( RemoteConsoleExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> () that will be executed when the command is run

Returns

this command builder

executesRemoteConsole() [3/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesRemoteConsole ( RemoteConsoleResultingCommandExecutor  executor )

inherited

Adds an executor to the current command builder.

Parameters

executor

A lambda of type (RemoteConsoleResultingCommandExecutor, CommandArguments) -> int that will be executed when the command is run

Returns

this command builder

executesRemoteConsole() [4/4]

default Impl dev.jorel.commandapi.BukkitExecutable< Impl >.executesRemoteConsole ( RemoteConsoleResultingExecutionInfo  info )

inherited

Adds an executor to the current command builder.

Parameters

info	A lambda of type (ExecutionInfo) -> int that will be executed when the command is run

Returns

this command builder

getArguments()

List< Argument > dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.getArguments ( )

inherited

Returns the list of arguments that this command has.

Returns

the list of arguments that this command has

getSubcommands()

List< Impl > dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.getSubcommands ( )

inherited

Returns the list of subcommands that this command has.

Returns

the list of subcommands that this command has

isConverted()

boolean dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.isConverted ( )

inherited

Returns whether this command is an automatically converted command.

Returns

whether this command is an automatically converted command

register() [1/2]

void dev.jorel.commandapi.CommandAPICommand.register

(

JavaPlugin

plugin

)

Registers this command with a given JavaPlugin instance.

Parameters

plugin

The plugin instance used to determine this command's namespace

register() [2/2]

void dev.jorel.commandapi.CommandAPICommand.register

(

String

namespace

)

Registers the command with a given namespace.

Parameters

namespace

The namespace of this command. This cannot be null or empty

setArguments()

void dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.setArguments ( List< Argument >  args )

inherited

Sets the arguments that this command has.

Parameters

args	the arguments that this command has

setSubcommands()

void dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.setSubcommands ( List< Impl >  subcommands )

inherited

Sets the list of subcommands that this command has.

Parameters

subcommands

the list of subcommands that this command has

withArguments() [1/2]

final Impl dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.withArguments ( Argument...  args )

inherited

Appends the argument(s) to the current command builder.

Parameters

args	Arguments that this command can accept

Returns

this command builder

withArguments() [2/2]

Impl dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.withArguments ( List< Argument >  args )

inherited

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

withHelp()

CommandAPICommand dev.jorel.commandapi.CommandAPICommand.withHelp

(

HelpTopic

helpTopic

)

Sets the HelpTopic for this command.

Using this method will override any declared short description, full description or usage description provided via the following methods:

• CommandAPICommand#withShortDescription(String)
• CommandAPICommand#withFullDescription(String)
• CommandAPICommand#withUsage(String...)
• CommandAPICommand#withHelp(String, String)

Parameters

helpTopic

the help topic to use for this command

Returns

this command builder

withOptionalArguments() [1/2]

final Impl dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.withOptionalArguments ( Argument...  args )

inherited

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

withOptionalArguments() [2/2]

Impl dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.withOptionalArguments ( List< Argument >  args )

inherited

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

withSubcommand()

Impl dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.withSubcommand ( Impl  subcommand )

inherited

Adds a subcommand to this command builder.

Parameters

subcommand

the subcommand to add as a child of this command

Returns

this command builder

withSubcommands()

Impl dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >.withSubcommands ( @SuppressWarnings("unchecked") Impl...  subcommands )

inherited

Adds subcommands to this command builder.

Parameters

subcommands

the subcommands to add as children of this command

Returns

this command builder