Interface CommandBuilderSource<C>
- All Known Implementing Classes:
CommandManager
-
Method Summary
Modifier and TypeMethodDescriptiondefault @NonNull Command.Builder<C> commandBuilder(@NonNull String name, @NonNull String... aliases) Creates a new command builder using default command meta created bycreateDefaultCommandMeta(), 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 bycreateDefaultCommandMeta().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.Constructs a defaultCommandMetainstance.decorateBuilder(@NonNull Command.Builder<C> builder) Decorates the givenbuilderand 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 namealiases- command aliasesdescription- description for the root literalmeta- 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 namealiases- command aliasesmeta- 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 namemeta- command metadescription- description for the root literalaliases- 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 namemeta- command metaaliases- 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 bycreateDefaultCommandMeta().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 namedescription- description for the root literalaliases- command aliases- Returns:
- the builder instance
- Throws:
UnsupportedOperationException- If the implementation does not support default command meta creation- See Also:
-
commandBuilder
default @NonNull Command.Builder<C> commandBuilder(@NonNull String name, @NonNull String... aliases) Creates a new command builder using default command meta created bycreateDefaultCommandMeta(), 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 namealiases- command aliases- Returns:
- the builder instance
- Throws:
UnsupportedOperationException- If the implementation does not support default command meta creation- See Also:
-
createDefaultCommandMeta
@NonNull CommandMeta createDefaultCommandMeta()Constructs a defaultCommandMetainstance.- Returns:
- default command meta
-
decorateBuilder
@API(status=INTERNAL) @NonNull Command.Builder<C> decorateBuilder(@NonNull Command.Builder<C> builder) Decorates the givenbuilderand returns the result.This should only be called by
CommandBuilderSourceto prepare the builders.- Parameters:
builder- builder to decorate- Returns:
- the decorated builder
-