Package org.incendo.cloud

Class Command.Builder<C>

java.lang.Object

org.incendo.cloud.Command.Builder<C>

Type Parameters:

C - command sender type

Enclosing class:

Command<C>

@API(status=STABLE)
public static final class Command.Builder<C>
extends Object

Builder for Command instances. The builder is immutable, and each setter method will return a new builder instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Command.Builder.Applicable<C>	Essentially a UnaryOperator for Command.Builder, but as a separate interface to avoid conflicts.

Method Summary

Modifier and Type	Method	Description
@NonNull Command.Builder<C>	appendHandler(@NonNull CommandExecutionHandler<C> handler)	Sets a new command execution handler that invokes the given handler after the current handler.
@NonNull Command.Builder<@NonNull C>	apply(@NonNull Command.Builder.Applicable<@NonNull C> applicable)	Applies the provided Command.Builder.Applicable to this Command.Builder, and returns the result.
@NonNull Command.Builder<C>	argument(@NonNull CommandComponent<? super C> argument)	Adds the given argument to the command.
<T> @NonNull Command.Builder<C>	argument(CommandComponent.Builder<? super C,T> builder)	Adds the given argument to the command.
@NonNull Command<C>	build()	Builds a command using the builder instance.
@NonNull CommandDescription	commandDescription()	Returns the current command description of this command builder.
@NonNull Command.Builder<C>	commandDescription(@NonNull CommandDescription commandDescription)	Returns a new builder with the given commandDescription.
@NonNull Command.Builder<C>	commandDescription(@NonNull Description commandDescription)	Returns the result of invoking commandDescription(CommandDescription) with the result of CommandDescription.commandDescription(Description).
@NonNull Command.Builder<C>	commandDescription(@NonNull Description commandDescription, @NonNull Description verboseCommandDescription)	Returns the result of invoking commandDescription(CommandDescription) with the result of CommandDescription.commandDescription(Description, Description).
@NonNull Permission	commandPermission()	Returns the required command permission for this builder.
<T> @NonNull Command.Builder<C>	flag(@NonNull CommandFlag<T> flag)	Registers a new command flag.
<T> @NonNull Command.Builder<C>	flag(@NonNull CommandFlag.Builder<C,T> builder)	Registers a new command flag.
@NonNull Command.Builder<C>	futureHandler(@NonNull CommandExecutionHandler.FutureCommandExecutionHandler<C> commandExecutionHandler)	Specifies the command execution handler.
@NonNull CommandExecutionHandler<C>	handler()	Returns the current command execution handler.
@NonNull Command.Builder<C>	handler(@NonNull CommandExecutionHandler<C> commandExecutionHandler)	Specifies the command execution handler.
@NonNull Command.Builder<C>	literal(@NonNull String main, @NonNull String... aliases)	Inserts a required literal into the command chain.
@NonNull Command.Builder<C>	literal(@NonNull String main, @NonNull Description description, @NonNull String... aliases)	Inserts a required literal into the command chain.
@NonNull Command.Builder<C>	manager(@Nullable CommandManager<C> commandManager)	Supplies a command manager instance to the builder.
@NonNull CommandMeta	meta()	Returns the current command meta value.
<V> @NonNull Command.Builder<C>	meta(@NonNull CloudKey<V> key, @NonNull V value)	Adds command meta to the internal command meta-map.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull CommandComponent.Builder<? super C,T> builder)	Marks the builder as optional and adds it to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull DefaultValue<? super C,T> defaultValue)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull DefaultValue<? super C,T> defaultValue, @NonNull Description description)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull DefaultValue<? super C,T> defaultValue, @NonNull Description description, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull DefaultValue<? super C,T> defaultValue, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull Description description)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull Description description, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CommandComponent.Builder<? super C,T> builder)	Marks the builder as optional and adds it to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull DefaultValue<? super C,T> defaultValue)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull DefaultValue<? super C,T> defaultValue, @NonNull Description description)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull DefaultValue<? super C,T> defaultValue, @NonNull Description description, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull DefaultValue<? super C,T> defaultValue, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull Description description)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull Description description, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given optional argument to the command.
<T> @NonNull Command.Builder<C>	optional(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given optional argument to the command.
<U, V, O> @NonNull Command.Builder<C>	optionalArgumentPair(@NonNull String name, @NonNull TypeToken<O> outputType, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> mapper, @NonNull Description description)	Creates a new argument pair that maps to a custom type.
<U, V> @NonNull Command.Builder<C>	optionalArgumentPair(@NonNull String name, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull Description description)	Creates a new argument pair that maps to Pair.
<U, V, O> @NonNull Command.Builder<C>	optionalArgumentPair(@NonNull CloudKey<O> name, @NonNull TypeToken<O> outputType, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> mapper, @NonNull Description description)	Creates a new argument pair that maps to a custom type.
<U, V> @NonNull Command.Builder<C>	optionalArgumentPair(@NonNull CloudKey<Pair<U,V>> name, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull Description description)	Creates a new argument pair that maps to Pair.
<U, V, W, O> @NonNull Command.Builder<C>	optionalArgumentTriplet(@NonNull String name, @NonNull TypeToken<O> outputType, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,W> thirdParser, @NonNull AggregateParserTripletBuilder.Mapper<C,U,V,W,O> mapper, @NonNull Description description)	Creates a new argument triplet that maps to a custom type.
<U, V, W> @NonNull Command.Builder<C>	optionalArgumentTriplet(@NonNull String name, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,W> thirdParser, @NonNull Description description)	Create a new argument pair that maps to Triplet
<U, V, W, O> @NonNull Command.Builder<C>	optionalArgumentTriplet(@NonNull CloudKey<O> name, @NonNull TypeToken<O> outputType, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,W> thirdParser, @NonNull AggregateParserTripletBuilder.Mapper<C,U,V,W,O> mapper, @NonNull Description description)	Creates a new argument triplet that maps to a custom type.
<U, V, W> @NonNull Command.Builder<C>	optionalArgumentTriplet(@NonNull CloudKey<Triplet<U,V,W>> name, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,W> thirdParser, @NonNull Description description)	Create a new argument pair that maps to Triplet
@NonNull Command.Builder<C>	permission(@NonNull String permission)	Specifies a command permission.
@NonNull Command.Builder<C>	permission(@NonNull Permission permission)	Specifies a command permission.
@NonNull Command.Builder<C>	permission(@NonNull PredicatePermission<C> permission)	Specifies a command permission.
@NonNull Command.Builder<C>	prependHandler(@NonNull CommandExecutionHandler<C> handler)	Sets a new command execution handler that invokes the given handler before the current handler.
<N extends C> @NonNull Command.Builder<N>	proxies(@NonNull Command<N> command)	Makes the current command be a proxy of the supplied command.
<T> @NonNull Command.Builder<C>	required(@NonNull String name, @NonNull CommandComponent.Builder<? super C,T> builder)	Marks the builder as required and adds it to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser)	Adds the given required argument to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull Description description)	Adds the given required argument to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull Description description, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given required argument to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull String name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given required argument to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull CommandComponent.Builder<? super C,T> builder)	Marks the builder as required and adds it to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser)	Adds the given required argument to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull Description description)	Adds the given required argument to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull Description description, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given required argument to the command.
<T> @NonNull Command.Builder<C>	required(@NonNull CloudKey<T> name, @NonNull ParserDescriptor<? super C,T> parser, @NonNull SuggestionProvider<? super C> suggestions)	Adds the given required argument to the command.
<U, V, O> @NonNull Command.Builder<C>	requiredArgumentPair(@NonNull String name, @NonNull TypeToken<O> outputType, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> mapper, @NonNull Description description)	Creates a new argument pair that maps to a custom type.
<U, V> @NonNull Command.Builder<C>	requiredArgumentPair(@NonNull String name, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull Description description)	Creates a new argument pair that maps to Pair.
<U, V, O> @NonNull Command.Builder<C>	requiredArgumentPair(@NonNull CloudKey<O> name, @NonNull TypeToken<O> outputType, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> mapper, @NonNull Description description)	Creates a new argument pair that maps to a custom type.
<U, V> @NonNull Command.Builder<C>	requiredArgumentPair(@NonNull CloudKey<Pair<U,V>> name, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull Description description)	Creates a new argument pair that maps to Pair.
<U, V, W, O> @NonNull Command.Builder<C>	requiredArgumentTriplet(@NonNull String name, @NonNull TypeToken<O> outputType, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,W> thirdParser, @NonNull AggregateParserTripletBuilder.Mapper<C,U,V,W,O> mapper, @NonNull Description description)	Creates a new argument triplet that maps to a custom type.
<U, V, W> @NonNull Command.Builder<C>	requiredArgumentTriplet(@NonNull String name, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,W> thirdParser, @NonNull Description description)	Create a new argument pair that maps to Triplet
<U, V, W, O> @NonNull Command.Builder<C>	requiredArgumentTriplet(@NonNull CloudKey<O> name, @NonNull TypeToken<O> outputType, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,W> thirdParser, @NonNull AggregateParserTripletBuilder.Mapper<C,U,V,W,O> mapper, @NonNull Description description)	Creates a new argument triplet that maps to a custom type.
<U, V, W> @NonNull Command.Builder<C>	requiredArgumentTriplet(@NonNull CloudKey<Triplet<U,V,W>> name, @NonNull String firstName, @NonNull ParserDescriptor<C,U> firstParser, @NonNull String secondName, @NonNull ParserDescriptor<C,V> secondParser, @NonNull String thirdName, @NonNull ParserDescriptor<C,W> thirdParser, @NonNull Description description)	Create a new argument pair that maps to Triplet
@Nullable TypeToken<? extends C>	senderType()	Returns the required sender type for this builder.
<N extends C> @NonNull Command.Builder<N>	senderType(@NonNull TypeToken<? extends N> senderType)	Specifies a required sender type.
<N extends C> @NonNull Command.Builder<N>	senderType(@NonNull Class<? extends N> senderType)	Specifies a required sender type.

Methods inherited from class java.lang.Object

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

Method Details

senderType

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

Returns the required sender type for this builder.

Returns null when there is not a specific required sender type.

Returns:

required sender type

commandPermission

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

Returns the required command permission for this builder.

Will return Permission.empty() if there is no required permission.

Returns:

required permission

meta

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

Returns the current command meta value.

Returns:

current command meta

apply

@API(status=STABLE)
public @NonNull Command.Builder<@NonNull C> apply(@NonNull Command.Builder.Applicable<@NonNull C> applicable)

Applies the provided Command.Builder.Applicable to this Command.Builder, and returns the result.

Parameters:

applicable - operation

Returns:

operation result

meta

@API(status=STABLE)
public <V> @NonNull Command.Builder<C> meta(@NonNull CloudKey<V> key,
 @NonNull V value)

Adds command meta to the internal command meta-map.

Type Parameters:

V - meta value type

Parameters:

key - meta key

value - meta value

Returns:

new builder instance using the inserted meta key-value pair

manager

public @NonNull Command.Builder<C> manager(@Nullable CommandManager<C> commandManager)

Supplies a command manager instance to the builder.

This will be used when attempting to retrieve command argument parsers, in the case that they're needed.

This is optional.

Parameters:

commandManager - Command manager

Returns:

new builder instance using the provided command manager

commandDescription

@API(status=STABLE)
public @NonNull Command.Builder<C> commandDescription(@NonNull CommandDescription commandDescription)

Returns a new builder with the given commandDescription.

See Command.commandDescription() for information about the description.

Parameters:

commandDescription - the new command description

Returns:

new builder instance using the provided command description

commandDescription

public @NonNull CommandDescription commandDescription()

Returns the current command description of this command builder.

Returns:

the current description

commandDescription

public @NonNull Command.Builder<C> commandDescription(@NonNull Description commandDescription)

Returns the result of invoking commandDescription(CommandDescription) with the result of CommandDescription.commandDescription(Description).

Parameters:

commandDescription - the new command description

Returns:

new builder instance using the provided command description

commandDescription

public @NonNull Command.Builder<C> commandDescription(@NonNull Description commandDescription,
 @NonNull Description verboseCommandDescription)

Returns the result of invoking commandDescription(CommandDescription) with the result of CommandDescription.commandDescription(Description, Description).

Parameters:

commandDescription - the new command description

verboseCommandDescription - the new verbose command description

Returns:

new builder instance using the provided command description

literal

public @NonNull Command.Builder<C> literal(@NonNull String main,
 @NonNull String... aliases)

Inserts a required literal into the command chain.

Parameters:

main - main argument name

aliases - argument aliases

Returns:

new builder instance with the modified command chain

literal

@API(status=STABLE)
public @NonNull Command.Builder<C> literal(@NonNull String main,
 @NonNull Description description,
 @NonNull String... aliases)

Inserts a required literal into the command chain.

Parameters:

main - main argument name

description - literal description

aliases - argument aliases

Returns:

new builder instance with the modified command chain

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull String name,
 @NonNull CommandComponent.Builder<? super C,T> builder)

Marks the builder as required and adds it to the command.

Type Parameters:

T - value type

Parameters:

name - the name that will be inserted into the builder

builder - the component builder

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull CommandComponent.Builder<? super C,T> builder)

Marks the builder as optional and adds it to the command.

Type Parameters:

T - value type

Parameters:

name - the name that will be inserted into the builder

builder - the component builder

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull CommandComponent.Builder<? super C,T> builder)

Marks the builder as required and adds it to the command.

Type Parameters:

T - value type

Parameters:

builder - the component builder

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CommandComponent.Builder<? super C,T> builder)

Marks the builder as optional and adds it to the command.

Type Parameters:

T - value type

Parameters:

builder - the component builder

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser)

Adds the given required argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given required argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser)

Adds the given required argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given required argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull Description description)

Adds the given required argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

description - the description of the argument

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull Description description,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given required argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

description - the description of the argument

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull Description description)

Adds the given required argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

description - the description of the argument

Returns:

new builder instance with the command argument inserted into the argument list

required

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> required(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull Description description,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given required argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

description - the description of the argument

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull Description description)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

description - the description of the argument

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull Description description,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

description - the description of the argument

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull Description description)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

description - the description of the argument

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull Description description,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

description - the description of the argument

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull DefaultValue<? super C,T> defaultValue)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

defaultValue - the default value

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull DefaultValue<? super C,T> defaultValue,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

defaultValue - the default value

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull DefaultValue<? super C,T> defaultValue)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

defaultValue - the default value

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull DefaultValue<? super C,T> defaultValue,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

defaultValue - the default value

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull DefaultValue<? super C,T> defaultValue,
 @NonNull Description description)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

defaultValue - the default value

description - the description of the argument

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull String name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull DefaultValue<? super C,T> defaultValue,
 @NonNull Description description,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

defaultValue - the default value

description - the description of the argument

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull DefaultValue<? super C,T> defaultValue,
 @NonNull Description description)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

defaultValue - the default value

description - the description of the argument

Returns:

new builder instance with the command argument inserted into the argument list

optional

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> optional(@NonNull CloudKey<T> name,
 @NonNull ParserDescriptor<? super C,T> parser,
 @NonNull DefaultValue<? super C,T> defaultValue,
 @NonNull Description description,
 @NonNull SuggestionProvider<? super C> suggestions)

Adds the given optional argument to the command.

Type Parameters:

T - the type produced by the parser

Parameters:

name - the name of the argument

parser - the parser

defaultValue - the default value

description - the description of the argument

suggestions - the suggestion provider

Returns:

new builder instance with the command argument inserted into the argument list

argument

@API(status=STABLE)
public @NonNull Command.Builder<C> argument(@NonNull CommandComponent<? super C> argument)

Adds the given argument to the command.

Parameters:

argument - argument to add

Returns:

new builder instance with the command argument inserted into the argument list

argument

@API(status=STABLE)
public <T> @NonNull Command.Builder<C> argument(CommandComponent.Builder<? super C,T> builder)

Adds the given argument to the command.

Type Parameters:

T - value type

Parameters:

builder - builder that builds the component to add

Returns:

new builder instance with the command argument inserted into the argument list

requiredArgumentPair

@API(status=STABLE)
public <U,
V> @NonNull Command.Builder<C> requiredArgumentPair(@NonNull String name,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull Description description)

Creates a new argument pair that maps to Pair.

Type Parameters:

U - first type

V - second type

Parameters:

name - name of the argument

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

description - description of the argument

Returns:

new builder instance with the argument inserted

requiredArgumentPair

@API(status=STABLE)
public <U,
V> @NonNull Command.Builder<C> requiredArgumentPair(@NonNull CloudKey<Pair<U,V>> name,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull Description description)

Creates a new argument pair that maps to Pair.

Type Parameters:

U - first type

V - second type

Parameters:

name - name of the argument

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

description - description of the argument

Returns:

new builder instance with the argument inserted

optionalArgumentPair

@API(status=STABLE)
public <U,
V> @NonNull Command.Builder<C> optionalArgumentPair(@NonNull String name,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull Description description)

Creates a new argument pair that maps to Pair.

Type Parameters:

U - first type

V - second type

Parameters:

name - name of the argument

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

description - description of the argument

Returns:

new builder instance with the argument inserted

optionalArgumentPair

@API(status=STABLE)
public <U,
V> @NonNull Command.Builder<C> optionalArgumentPair(@NonNull CloudKey<Pair<U,V>> name,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull Description description)

Creates a new argument pair that maps to Pair.

Type Parameters:

U - first type

V - second type

Parameters:

name - name of the argument

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

description - description of the argument

Returns:

new builder instance with the argument inserted

requiredArgumentPair

@API(status=STABLE)
public <U,
V,
O> @NonNull Command.Builder<C> requiredArgumentPair(@NonNull String name,
 @NonNull TypeToken<O> outputType,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> mapper,
 @NonNull Description description)

Creates a new argument pair that maps to a custom type.

Type Parameters:

U - first type

V - second type

O - output type

Parameters:

name - name of the argument

outputType - the output type

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

mapper - mapper that maps from Pair to the custom type

description - description of the argument

Returns:

new builder instance with the argument inserted

requiredArgumentPair

@API(status=STABLE)
public <U,
V,
O> @NonNull Command.Builder<C> requiredArgumentPair(@NonNull CloudKey<O> name,
 @NonNull TypeToken<O> outputType,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> mapper,
 @NonNull Description description)

Creates a new argument pair that maps to a custom type.

Type Parameters:

U - first type

V - second type

O - output type

Parameters:

name - name of the argument

outputType - the output type

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

mapper - mapper that maps from Pair to the custom type

description - description of the argument

Returns:

new builder instance with the argument inserted

optionalArgumentPair

@API(status=STABLE)
public <U,
V,
O> @NonNull Command.Builder<C> optionalArgumentPair(@NonNull String name,
 @NonNull TypeToken<O> outputType,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> mapper,
 @NonNull Description description)

Creates a new argument pair that maps to a custom type.

Type Parameters:

U - first type

V - second type

O - output type

Parameters:

name - name of the argument

outputType - the output type

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

mapper - mapper that maps from Pair to the custom type

description - description of the argument

Returns:

new builder instance with the argument inserted

optionalArgumentPair

@API(status=STABLE)
public <U,
V,
O> @NonNull Command.Builder<C> optionalArgumentPair(@NonNull CloudKey<O> name,
 @NonNull TypeToken<O> outputType,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> mapper,
 @NonNull Description description)

Creates a new argument pair that maps to a custom type.

Type Parameters:

U - first type

V - second type

O - output type

Parameters:

name - name of the argument

outputType - the output type

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

mapper - mapper that maps from Pair to the custom type

description - description of the argument

Returns:

new builder instance with the argument inserted

requiredArgumentTriplet

@API(status=STABLE)
public <U,
V,
W> @NonNull Command.Builder<C> requiredArgumentTriplet(@NonNull String name,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,W> thirdParser,
 @NonNull Description description)

Create a new argument pair that maps to Triplet

Type Parameters:

U - first type

V - second type

W - third type

Parameters:

name - name of the argument

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

thirdName - name of the third subcomponent

thirdParser - parser for the third subcomponent

description - description of the argument

Returns:

new builder instance with the argument inserted

requiredArgumentTriplet

@API(status=STABLE)
public <U,
V,
W> @NonNull Command.Builder<C> requiredArgumentTriplet(@NonNull CloudKey<Triplet<U,V,W>> name,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,W> thirdParser,
 @NonNull Description description)

Create a new argument pair that maps to Triplet

For this to work, there must be a CommandManager attached to the command builder. To guarantee this, it is recommended to get the command builder instance using CommandBuilderSource.commandBuilder(String, String...).

Type Parameters:

U - first type

V - second type

W - third type

Parameters:

name - name of the argument

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

thirdName - name of the third subcomponent

thirdParser - parser for the third subcomponent

description - description of the argument

Returns:

new builder instance with the argument inserted

optionalArgumentTriplet

@API(status=STABLE)
public <U,
V,
W> @NonNull Command.Builder<C> optionalArgumentTriplet(@NonNull String name,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,W> thirdParser,
 @NonNull Description description)

Create a new argument pair that maps to Triplet

For this to work, there must be a CommandManager attached to the command builder. To guarantee this, it is recommended to get the command builder instance using CommandBuilderSource.commandBuilder(String, String...).

Type Parameters:

U - first type

V - second type

W - third type

Parameters:

name - name of the argument

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

thirdName - name of the third subcomponent

thirdParser - parser for the third subcomponent

description - description of the argument

Returns:

new builder instance with the argument inserted

optionalArgumentTriplet

@API(status=STABLE)
public <U,
V,
W> @NonNull Command.Builder<C> optionalArgumentTriplet(@NonNull CloudKey<Triplet<U,V,W>> name,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,W> thirdParser,
 @NonNull Description description)

Create a new argument pair that maps to Triplet

For this to work, there must be a CommandManager attached to the command builder. To guarantee this, it is recommended to get the command builder instance using CommandBuilderSource.commandBuilder(String, String...).

Type Parameters:

U - first type

V - second type

W - third type

Parameters:

name - name of the argument

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

thirdName - name of the third subcomponent

thirdParser - parser for the third subcomponent

description - description of the argument

Returns:

new builder instance with the argument inserted

requiredArgumentTriplet

@API(status=STABLE)
public <U,
V,
W,
O> @NonNull Command.Builder<C> requiredArgumentTriplet(@NonNull String name,
 @NonNull TypeToken<O> outputType,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,W> thirdParser,
 @NonNull AggregateParserTripletBuilder.Mapper<C,U,V,W,O> mapper,
 @NonNull Description description)

Creates a new argument triplet that maps to a custom type.

For this to work, there must be a CommandManager attached to the command builder. To guarantee this, it is recommended to get the command builder instance using CommandBuilderSource.commandBuilder(String, String...).

Type Parameters:

U - first type

V - second type

W - third type

O - output type

Parameters:

name - name of the argument

outputType - the output type

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

thirdName - name of the third subcomponent

thirdParser - parser for the third subcomponent

mapper - mapper that maps from Triplet to the custom type

description - description of the argument

Returns:

new builder instance with the argument inserted

requiredArgumentTriplet

@API(status=STABLE)
public <U,
V,
W,
O> @NonNull Command.Builder<C> requiredArgumentTriplet(@NonNull CloudKey<O> name,
 @NonNull TypeToken<O> outputType,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,W> thirdParser,
 @NonNull AggregateParserTripletBuilder.Mapper<C,U,V,W,O> mapper,
 @NonNull Description description)

Creates a new argument triplet that maps to a custom type.

For this to work, there must be a CommandManager attached to the command builder. To guarantee this, it is recommended to get the command builder instance using CommandBuilderSource.commandBuilder(String, String...).

Type Parameters:

U - first type

V - second type

W - third type

O - output type

Parameters:

name - name of the argument

outputType - the output type

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

thirdName - name of the third subcomponent

thirdParser - parser for the third subcomponent

mapper - Mapper that maps from Triplet to the custom type

description - description of the argument

Returns:

new builder instance with the argument inserted

optionalArgumentTriplet

@API(status=STABLE)
public <U,
V,
W,
O> @NonNull Command.Builder<C> optionalArgumentTriplet(@NonNull String name,
 @NonNull TypeToken<O> outputType,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,W> thirdParser,
 @NonNull AggregateParserTripletBuilder.Mapper<C,U,V,W,O> mapper,
 @NonNull Description description)

Creates a new argument triplet that maps to a custom type.

For this to work, there must be a CommandManager attached to the command builder. To guarantee this, it is recommended to get the command builder instance using CommandBuilderSource.commandBuilder(String, String...).

Type Parameters:

U - first type

V - second type

W - third type

O - output type

Parameters:

name - name of the argument

outputType - the output type

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

thirdName - name of the third subcomponent

thirdParser - parser for the third subcomponent

mapper - mapper that maps from Triplet to the custom type

description - description of the argument

Returns:

new builder instance with the argument inserted

optionalArgumentTriplet

@API(status=STABLE)
public <U,
V,
W,
O> @NonNull Command.Builder<C> optionalArgumentTriplet(@NonNull CloudKey<O> name,
 @NonNull TypeToken<O> outputType,
 @NonNull String firstName,
 @NonNull ParserDescriptor<C,U> firstParser,
 @NonNull String secondName,
 @NonNull ParserDescriptor<C,V> secondParser,
 @NonNull String thirdName,
 @NonNull ParserDescriptor<C,W> thirdParser,
 @NonNull AggregateParserTripletBuilder.Mapper<C,U,V,W,O> mapper,
 @NonNull Description description)

Creates a new argument triplet that maps to a custom type.

For this to work, there must be a CommandManager attached to the command builder. To guarantee this, it is recommended to get the command builder instance using CommandBuilderSource.commandBuilder(String, String...).

Type Parameters:

U - first type

V - second type

W - third type

O - output type

Parameters:

name - name of the argument

outputType - the output type

firstName - name of the first subcomponent

firstParser - parser for the first subcomponent

secondName - name of the second subcomponent

secondParser - parser for the second subcomponent

thirdName - name of the third subcomponent

thirdParser - parser for the third subcomponent

mapper - mapper that maps from Triplet to the custom type

description - description of the argument

Returns:

new builder instance with the argument inserted

handler

public @NonNull Command.Builder<C> handler(@NonNull CommandExecutionHandler<C> commandExecutionHandler)

Specifies the command execution handler.

Parameters:

commandExecutionHandler - New execution handler

Returns:

new builder instance using the command execution handler

futureHandler

public @NonNull Command.Builder<C> futureHandler(@NonNull CommandExecutionHandler.FutureCommandExecutionHandler<C> commandExecutionHandler)

Specifies the command execution handler.

Parameters:

commandExecutionHandler - New execution handler

Returns:

new builder instance using the command execution handler

handler

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

Returns the current command execution handler.

Returns:

the current handler

prependHandler

@API(status=STABLE)
public @NonNull Command.Builder<C> prependHandler(@NonNull CommandExecutionHandler<C> handler)

Sets a new command execution handler that invokes the given handler before the current handler.

Parameters:

handler - the handler to invoke before the current handler

Returns:

new builder instance

appendHandler

@API(status=STABLE)
public @NonNull Command.Builder<C> appendHandler(@NonNull CommandExecutionHandler<C> handler)

Sets a new command execution handler that invokes the given handler after the current handler.

Parameters:

handler - the handler to invoke after the current handler

Returns:

new builder instance

senderType

public <N extends C> @NonNull Command.Builder<N> senderType(@NonNull Class<? extends N> senderType)

Specifies a required sender type.

Type Parameters:

N - the new sender type or a superclass thereof

Parameters:

senderType - required sender type

Returns:

new builder instance using the required sender type

senderType

public <N extends C> @NonNull Command.Builder<N> senderType(@NonNull TypeToken<? extends N> senderType)

Specifies a required sender type.

Type Parameters:

N - the new sender type or a superclass thereof

Parameters:

senderType - required sender type

Returns:

new builder instance using the required sender type

permission

public @NonNull Command.Builder<C> permission(@NonNull Permission permission)

Specifies a command permission.

Parameters:

permission - the command permission

Returns:

new builder instance using the command permission

permission

public @NonNull Command.Builder<C> permission(@NonNull PredicatePermission<C> permission)

Specifies a command permission.

Parameters:

permission - the command permission

Returns:

new builder instance using the command permission

permission

public @NonNull Command.Builder<C> permission(@NonNull String permission)

Specifies a command permission.

Parameters:

permission - the command permission

Returns:

new builder instance using the command permission

proxies

public <N extends C> @NonNull Command.Builder<N> proxies(@NonNull Command<N> command)

Makes the current command be a proxy of the supplied command. T

This means that all the proxied command's variable command arguments will be inserted into this builder instance, in the order they are declared in the proxied command. Furthermore, the proxied command's command handler will be shown by the command that is currently being built. If the current command builder does not have a permission node set, this too will be copied.

Type Parameters:

N - new command sender type

Parameters:

command - the command to proxy

Returns:

new builder that proxies the given command

flag

public <T> @NonNull Command.Builder<C> flag(@NonNull CommandFlag<T> flag)

Registers a new command flag.

Type Parameters:

T - flag value type

Parameters:

flag - flag

Returns:

new builder instance that uses the provided flag

flag

public <T> @NonNull Command.Builder<C> flag(@NonNull CommandFlag.Builder<C,T> builder)

Registers a new command flag.

Type Parameters:

T - flag value type

Parameters:

builder - flag builder. CommandFlag.Builder.build() will be invoked.

Returns:

new builder instance that uses the provided flag

build

public @NonNull Command<C> build()

Builds a command using the builder instance.

Returns:

built command