Package org.incendo.cloud.bean

Class CommandBean<C>

java.lang.Object

org.incendo.cloud.bean.CommandBean<C>

Type Parameters:

C - the command sender type

All Implemented Interfaces:

CommandFactory<C>, CommandExecutionHandler<C>

@API(status=STABLE)
public abstract class CommandBean<C>
extends Object
implements CommandExecutionHandler<C>, CommandFactory<C>

An alternative way of registering commands, where each command lives in a separate class.

The command bean is a CommandExecutionHandler and will be set as the handler of the command by default. The execute(CommandContext) or CommandExecutionHandler.executeFuture(CommandContext) methods can be overridden to implement your command handler. You may also provide custom handler when configure(Command.Builder) is invoked.

Information about the command, such as aliases, should be provided by properties(). The command bean may be registered to the command manager by using CommandManager.command(CommandFactory). This will invoke configure(Command.Builder) where you may configure the command. The command meta may be configured by overriding meta().

Nested Class Summary

Nested classes/interfaces inherited from interface org.incendo.cloud.execution.CommandExecutionHandler

CommandExecutionHandler.FutureCommandExecutionHandler<C>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommandBean()

Method Summary

Modifier and Type	Method	Description
protected abstract @NonNull Command.Builder<? extends C>	configure(@NonNull Command.Builder<C> builder)	Configures the command before it's registered to the command manager.
@NonNull List<@NonNull Command<? extends C>>	createCommands(@NonNull CommandManager<C> commandManager)	Constructs a command using the given commandManager.
void	execute(@NonNull CommandContext<C> commandContext)	Default command handler for this command bean.
protected @NonNull CommandMeta	meta()	Returns the command meta for the constructed command.
protected abstract @NonNull CommandProperties	properties()	Returns the properties of the command.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.incendo.cloud.execution.CommandExecutionHandler

executeFuture

Constructor Details

CommandBean

protected CommandBean()

Method Details

createCommands

public @NonNull List<@NonNull Command<? extends C>> createCommands(@NonNull CommandManager<C> commandManager)

Constructs a command using the given commandManager.

This invokes configure(Command.Builder) which allows for configuration of the command.

Specified by:

createCommands in interface CommandFactory<C>

Parameters:

commandManager - the command manager

Returns:

the constructed command

meta

protected @NonNull CommandMeta meta()

Returns the command meta for the constructed command.

Returns:

the command meta

properties

protected abstract @NonNull CommandProperties properties()

Returns the properties of the command.

Returns:

the command properties

configure

protected abstract @NonNull Command.Builder<? extends C> configure(@NonNull Command.Builder<C> builder)

Configures the command before it's registered to the command manager.

The command builder has been created by using the properties() and meta() of this bean. The builder has been pre-configured to use this instance as the CommandExecutionHandler.

Parameters:

builder - the command builder

Returns:

the updated builder

execute

public void execute(@NonNull CommandContext<C> commandContext)

Default command handler for this command bean. Does nothing unless override.

Specified by:

execute in interface CommandExecutionHandler<C>

Parameters:

commandContext - Command context