Package dev.oumaimaa.kawaiiapi.command

Class CommandManager.CommandBuilder

java.lang.Object

dev.oumaimaa.kawaiiapi.command.CommandManager.CommandBuilder

Enclosing class:

CommandManager

public static final class CommandManager.CommandBuilder
extends Object

Builder class for creating commands with a fluent API.

Constructor Summary

Constructors

Constructor	Description
CommandBuilder(@NotNull org.bukkit.plugin.java.JavaPlugin plugin)	Creates a new CommandBuilder.

Method Summary

Modifier and Type	Method	Description
CommandManager.CommandBuilder	addSubcommand(@NotNull Class<? extends SubCommand> subcommand)	Adds a subcommand class.
final CommandManager.CommandBuilder	addSubcommands(@NotNull Class<? extends SubCommand>... subcommands)	Adds multiple subcommand classes.
CommandManager.CommandBuilder	aliases(@NotNull String... aliases)	Sets the command aliases.
CommandManager.CommandBuilder	commandList(@Nullable CommandList commandList)	Sets the command list display handler.
CommandManager.CommandBuilder	description(@NotNull String description)	Sets the command description.
CommandManager.CommandBuilder	name(@NotNull String name)	Sets the command name.
void	register()	Builds and registers the command.
CommandManager.CommandBuilder	usage(@NotNull String usage)	Sets the command usage.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandBuilder

public CommandBuilder(@NotNull
 @NotNull org.bukkit.plugin.java.JavaPlugin plugin)

Creates a new CommandBuilder.

Parameters:

plugin - The plugin instance

Method Details

name

public CommandManager.CommandBuilder name(@NotNull
 @NotNull String name)

Sets the command name.

Parameters:

name - The command name

Returns:

This builder instance

description

public CommandManager.CommandBuilder description(@NotNull
 @NotNull String description)

Sets the command description.

Parameters:

description - The description

Returns:

This builder instance

usage

public CommandManager.CommandBuilder usage(@NotNull
 @NotNull String usage)

Sets the command usage.

Parameters:

usage - The usage string

Returns:

This builder instance

commandList

public CommandManager.CommandBuilder commandList(@Nullable
 @Nullable CommandList commandList)

Sets the command list display handler.

Parameters:

commandList - The command list handler

Returns:

This builder instance

aliases

public CommandManager.CommandBuilder aliases(@NotNull
 @NotNull String... aliases)

Sets the command aliases.

Parameters:

aliases - The aliases

Returns:

This builder instance

addSubcommand

public CommandManager.CommandBuilder addSubcommand(@NotNull
 @NotNull Class<? extends SubCommand> subcommand)

Adds a subcommand class.

Parameters:

subcommand - The subcommand class

Returns:

This builder instance

addSubcommands

@SafeVarargs
public final CommandManager.CommandBuilder addSubcommands(@NotNull
 @NotNull Class<? extends SubCommand>... subcommands)

Adds multiple subcommand classes.

Parameters:

subcommands - The subcommand classes

Returns:

This builder instance

register

public void register()

Builds and registers the command.

Throws:

IllegalStateException - if the command name is not set