Package org.incendo.cloud

Class Command<C>

java.lang.Object

org.incendo.cloud.Command<C>

Type Parameters:

C - command sender type

@API(status=STABLE)
public class Command<C>
extends Object

A command is a chain of command components with an associated commandExecutionHandler().

The recommended way of creating a command is by using a command builder. You may either create the command builder using newBuilder(String, CommandMeta, String...) or CommandBuilderSource.commandBuilder(String, String...). Getting a builder from the command manager means that the builder is linked to the manager. When the command builder is linked to the manager, it is able to retrieve parsers from the associated ParserRegistry in the case that only a parsed type is given to the builder, and not a complete parser. You may link any command builder to a command manager by using Command.Builder.manager(CommandManager).

All command flags added to a command builder will be collected into a single component. If there are flags added to the command, then they may be retrieved from the flagComponent() or from the flagParser().

Commands may have meta-data associated with them, which can be accessed using commandMeta(). A common way of using the command meta is by using it to filter out commands in post-processing.

A command may have a senderType() that is different from the sender type of the command manager. The command tree will enforce this type when parsing the command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Command.Builder<C>	Builder for Command instances.

Constructor Summary

Constructors

Constructor	Description
Command(@NonNull List<@NonNull CommandComponent<C>> commandComponents, @NonNull CommandExecutionHandler<@NonNull C> commandExecutionHandler, @Nullable Type senderType, @NonNull Permission permission, @NonNull CommandMeta commandMeta, @NonNull CommandDescription commandDescription)	Constructs a new command instance.

Method Summary

Modifier and Type	Method	Description
@NonNull CommandDescription	commandDescription()	Returns the description of the command.
@NonNull CommandExecutionHandler<@NonNull C>	commandExecutionHandler()	Returns the command execution handler.
@NonNull CommandMeta	commandMeta()	Returns the meta-data associated with the command.
@NonNull Permission	commandPermission()	Returns the permission required to execute the command.
@NonNull List<CommandComponent<C>>	components()	Returns a copy of the list of the components that make up this command.
@Nullable CommandComponent<C>	flagComponent()	Returns the component that contains the flags belonging to the command.
@Nullable CommandFlagParser<@NonNull C>	flagParser()	Returns the flag parser for this command, of null if the command has no flags.
static <C> @NonNull Command.Builder<C>	newBuilder(@NonNull String commandName, @NonNull CommandMeta commandMeta, @NonNull String @NonNull ... aliases)	Creates a new command builder.
static <C> @NonNull Command.Builder<C>	newBuilder(@NonNull String commandName, @NonNull CommandMeta commandMeta, @NonNull Description description, @NonNull String @NonNull ... aliases)	Creates a new command builder.
@NonNull List<CommandComponent<C>>	nonFlagArguments()	Returns a mutable copy of the command components, ignoring flag arguments.
@NonNull CommandComponent<C>	rootComponent()	Returns the first command component.
@NonNull Optional<TypeToken<? extends C>>	senderType()	Returns the specific command sender type for the command if one has been defined.
final String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Command

@API(status=INTERNAL)
public Command(@NonNull List<@NonNull CommandComponent<C>> commandComponents,
 @NonNull CommandExecutionHandler<@NonNull C> commandExecutionHandler,
 @Nullable Type senderType,
 @NonNull Permission permission,
 @NonNull CommandMeta commandMeta,
 @NonNull CommandDescription commandDescription)

Constructs a new command instance.

Parameters:

commandComponents - command component argument and description

commandExecutionHandler - execution handler

senderType - required sender type. May be null

permission - command permission

commandMeta - command meta instance

commandDescription - description of the command

Method Details

newBuilder

@API(status=STABLE)
public static <C> @NonNull Command.Builder<C> newBuilder(@NonNull String commandName,
 @NonNull CommandMeta commandMeta,
 @NonNull Description description,
 @NonNull String @NonNull ... aliases)

Creates a new command builder.

Is recommended to use the builder methods in CommandManager rather than invoking this method directly.

Type Parameters:

C - command sender type

Parameters:

commandName - base command argument

commandMeta - command meta instance

description - description of the root literal

aliases - command aliases

Returns:

command builder

newBuilder

public static <C> @NonNull Command.Builder<C> newBuilder(@NonNull String commandName,
 @NonNull CommandMeta commandMeta,
 @NonNull String @NonNull ... aliases)

Creates a new command builder.

Is recommended to use the builder methods in CommandManager rather than invoking this method directly.

Type Parameters:

C - command sender type

Parameters:

commandName - base command argument

commandMeta - command meta instance

aliases - command aliases

Returns:

command builder

components

@API(status=STABLE)
public @NonNull List<CommandComponent<C>> components()

Returns a copy of the list of the components that make up this command.

Returns:

modifiable copy of the component list

rootComponent

@API(status=STABLE)
public @NonNull CommandComponent<C> rootComponent()

Returns the first command component.

Returns:

the root component

nonFlagArguments

@API(status=EXPERIMENTAL)
public @NonNull List<CommandComponent<C>> nonFlagArguments()

Returns a mutable copy of the command components, ignoring flag arguments.

Returns:

argument list

flagComponent

@API(status=STABLE)
public @Nullable CommandComponent<C> flagComponent()

Returns the component that contains the flags belonging to the command.

Returns:

the flag component, or null if no flags have been registered

flagParser

@API(status=STABLE)
public @Nullable CommandFlagParser<@NonNull C> flagParser()

Returns the flag parser for this command, of null if the command has no flags.

Returns:

flag parser, or null if no flags have been registered

commandExecutionHandler

@API(status=STABLE)
public @NonNull CommandExecutionHandler<@NonNull C> commandExecutionHandler()

Returns the command execution handler.

The command execution handler is invoked after a parsing a command. It has access to the CommandContext which contains the parsed component values.

Returns:

the command execution handler

senderType

@API(status=STABLE)
public @NonNull Optional<TypeToken<? extends C>> senderType()

Returns the specific command sender type for the command if one has been defined.

A command may have a sender that is different from the sender type of the command manager. The command tree will enforce this type when parsing the command.

Returns:

the special sender type for the command, or Optional.empty() if the command uses the same sender type as the command manager

commandPermission

@API(status=STABLE)
public @NonNull Permission commandPermission()

Returns the permission required to execute the command.

If the sender does not have the required permission a NoPermissionException will be thrown when parsing the command.

Returns:

the command permission

commandMeta

@API(status=STABLE)
public @NonNull CommandMeta commandMeta()

Returns the meta-data associated with the command.

A common way of using the command meta is by using it to filter out commands in post-processing.

Returns:

Command meta

commandDescription

@API(status=STABLE)
public @NonNull CommandDescription commandDescription()

Returns the description of the command.

This is not the same as the description of the root component. The command description used to be configured through the commandMeta().

Returns:

the command description

toString

public final String toString()

Overrides:

toString in class Object