Package org.incendo.cloud

Interface CommandBuilderSource<C>

All Known Implementing Classes:

CommandManager

@API(status=STABLE)
public interface CommandBuilderSource<C>

Method Summary

Modifier and Type	Method	Description
default @NonNull Command.Builder<C>	commandBuilder(@NonNull String name, @NonNull String... aliases)	Creates a new command builder using default command meta created by createDefaultCommandMeta(), and an empty description.
default @NonNull Command.Builder<C>	commandBuilder(@NonNull String name, @NonNull Collection<String> aliases, @NonNull Description description, @NonNull CommandMeta meta)	Creates a new command builder.
default @NonNull Command.Builder<C>	commandBuilder(@NonNull String name, @NonNull Collection<String> aliases, @NonNull CommandMeta meta)	Creates a new command builder with an empty description.
default @NonNull Command.Builder<C>	commandBuilder(@NonNull String name, @NonNull Description description, @NonNull String... aliases)	Create a new command builder using default command meta created by createDefaultCommandMeta().
default @NonNull Command.Builder<C>	commandBuilder(@NonNull String name, @NonNull CommandMeta meta, @NonNull String... aliases)	Creates a new command builder with an empty description.
default @NonNull Command.Builder<C>	commandBuilder(@NonNull String name, @NonNull CommandMeta meta, @NonNull Description description, @NonNull String... aliases)	Creates a new command builder.
@NonNull CommandMeta	createDefaultCommandMeta()	Constructs a default CommandMeta instance.
@NonNull Command.Builder<C>	decorateBuilder(@NonNull Command.Builder<C> builder)	Decorates the given builder and returns the result.

Method Details

commandBuilder

default @NonNull Command.Builder<C> commandBuilder(@NonNull String name,
 @NonNull Collection<String> aliases,
 @NonNull Description description,
 @NonNull CommandMeta meta)

Creates a new command builder.

The builder will be decorated using decorateBuilder(Command.Builder).

This will not register the command. Use CommandManager.command(Command.Builder) to register the command.

Parameters:

name - command name

aliases - command aliases

description - description for the root literal

meta - command meta

Returns:

the builder instance

commandBuilder

default @NonNull Command.Builder<C> commandBuilder(@NonNull String name,
 @NonNull Collection<String> aliases,
 @NonNull CommandMeta meta)

Creates a new command builder with an empty description.

The builder will be decorated using decorateBuilder(Command.Builder).

This will not register the command. Use CommandManager.command(Command.Builder) to register the command.

Parameters:

name - command name

aliases - command aliases

meta - command meta

Returns:

the builder instance

commandBuilder

default @NonNull Command.Builder<C> commandBuilder(@NonNull String name,
 @NonNull CommandMeta meta,
 @NonNull Description description,
 @NonNull String... aliases)

Creates a new command builder.

The builder will be decorated using decorateBuilder(Command.Builder).

This will not register the command. Use CommandManager.command(Command.Builder) to register the command.

Parameters:

name - command name

meta - command meta

description - description for the root literal

aliases - command aliases

Returns:

the builder instance

commandBuilder

default @NonNull Command.Builder<C> commandBuilder(@NonNull String name,
 @NonNull CommandMeta meta,
 @NonNull String... aliases)

Creates a new command builder with an empty description.

The builder will be decorated using decorateBuilder(Command.Builder).

This will not register the command. Use CommandManager.command(Command.Builder) to register the command.

Parameters:

name - command name

meta - command meta

aliases - command aliases

Returns:

the builder instance

commandBuilder

default @NonNull Command.Builder<C> commandBuilder(@NonNull String name,
 @NonNull Description description,
 @NonNull String... aliases)

Create a new command builder using default command meta created by createDefaultCommandMeta().

The builder will be decorated using decorateBuilder(Command.Builder).

This will not register the command. Use CommandManager.command(Command.Builder) to register the command.

Parameters:

name - command name

description - description for the root literal

aliases - command aliases

Returns:

the builder instance

Throws:

UnsupportedOperationException - If the implementation does not support default command meta creation

See Also:

• default command meta creation

commandBuilder

default @NonNull Command.Builder<C> commandBuilder(@NonNull String name,
 @NonNull String... aliases)

Creates a new command builder using default command meta created by createDefaultCommandMeta(), and an empty description.

The builder will be decorated using decorateBuilder(Command.Builder).

This will not register the command. Use CommandManager.command(Command.Builder) to register the command.

Parameters:

name - command name

aliases - command aliases

Returns:

the builder instance

Throws:

UnsupportedOperationException - If the implementation does not support default command meta creation

See Also:

• Default command meta creation

createDefaultCommandMeta

@NonNull CommandMeta createDefaultCommandMeta()

Constructs a default CommandMeta instance.

Returns:

default command meta

decorateBuilder

@API(status=INTERNAL)
@NonNull Command.Builder<C> decorateBuilder(@NonNull Command.Builder<C> builder)

Decorates the given builder and returns the result.

This should only be called by CommandBuilderSource to prepare the builders.

Parameters:

builder - builder to decorate

Returns:

the decorated builder