Package org.incendo.cloud.bukkit

Class BukkitCommandManager<C>

java.lang.Object

org.incendo.cloud.CommandManager<C>

org.incendo.cloud.bukkit.BukkitCommandManager<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

BrigadierManagerHolder<C,Object>, PluginHolder, CommandBuilderSource<C>, SenderMapperHolder<CommandSender,C>, Stateful<RegistrationState>

public abstract class BukkitCommandManager<C>
extends CommandManager<C>
implements BrigadierManagerHolder<C,Object>, SenderMapperHolder<CommandSender,C>, PluginHolder

Base CommandManager implementation for Bukkit-based platforms.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BukkitCommandManager.BrigadierInitializationException	Exception thrown when Brigadier mappings fail to initialize.
static final class	BukkitCommandManager.InitializationException	Exception thrown when the command manager could not be initialized.

Nested classes/interfaces inherited from interface org.incendo.cloud.brigadier.BrigadierManagerHolder

BrigadierManagerHolder.BrigadierManagerNotPresent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BukkitCommandManager(@NonNull Plugin owningPlugin, @NonNull ExecutionCoordinator<C> commandExecutionCoordinator, @NonNull SenderMapper<CommandSender,C> senderMapper)	Create a new Bukkit command manager.

Method Summary

Modifier and Type	Method	Description
@NonNull CloudBrigadierManager<C,?>	brigadierManager()
protected final void	checkBrigadierCompatibility()	Check whether Brigadier can be used on the server instance
boolean	hasBrigadierManager()
final boolean	hasPermission(@NonNull C sender, @NonNull String permission)
final @NonNull Plugin	owningPlugin()	Returns the plugin that owns the manager.
void	registerBrigadier()	Attempts to enable Brigadier command registration through Commodore.
final @NonNull SenderMapper<CommandSender,C>	senderMapper()
protected final boolean	splitAliases()
protected final void	splitAliases(boolean value)

Methods inherited from class org.incendo.cloud.CommandManager

appendSuggestionMapper, capabilities, captionFormatter, captionFormatter, captionRegistry, captionRegistry, command, command, command, commandExecutor, commandRegistrationHandler, commandRegistrationHandler, commands, commandSyntaxFormatter, commandSyntaxFormatter, commandTree, componentBuilder, createDefaultCommandMeta, createHelpHandler, createHelpHandler, decorateBuilder, deleteRootCommand, exceptionController, flagBuilder, hasCapability, helpHandlerFactory, helpHandlerFactory, isCommandRegistrationAllowed, lockRegistration, parameterInjectorRegistry, parserRegistry, postprocessContext, preprocessContext, registerCapability, registerCommandPostProcessor, registerCommandPreProcessor, registerDefaultExceptionHandlers, rootCommands, settings, state, suggestionFactory, suggestionMapper, suggestionMapper, suggestionProcessor, suggestionProcessor, testPermission, transitionIfPossible

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.CommandBuilderSource

commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder

Methods inherited from interface org.incendo.cloud.state.Stateful

requireState, transitionOrThrow

Constructor Details

BukkitCommandManager

@API(status=INTERNAL,
     since="2.0.0")
protected BukkitCommandManager(@NonNull Plugin owningPlugin,
 @NonNull ExecutionCoordinator<C> commandExecutionCoordinator,
 @NonNull SenderMapper<CommandSender,C> senderMapper)
                        throws BukkitCommandManager.InitializationException

Create a new Bukkit command manager. BukkitCommandManager is not intended to be created and used directly. Instead, use PaperCommandManager from cloud-paper which extends BukkitCommandManager with specific support for Paper-based platforms, but does not lose support for non Paper-based Bukkit platforms.

Parameters:

owningPlugin - Plugin constructing the manager. Used when registering commands to the command map, registering event listeners, etc.

commandExecutionCoordinator - Execution coordinator instance. Due to Bukkit blocking the main thread for suggestion requests, it's potentially unsafe to use anything other than ExecutionCoordinator.nonSchedulingExecutor() for ExecutionCoordinator.Builder.suggestionsExecutor(Executor). Once the coordinator, a suggestion provider, parser, or similar routes suggestion logic off of the calling (main) thread, it won't be possible to schedule further logic back to the main thread without a deadlock. When Brigadier support is active, this issue is avoided, as it allows for non-blocking suggestions.

senderMapper - Mapper between Bukkit's CommandSender and the command sender type C.

Throws:

BukkitCommandManager.InitializationException - if construction of the manager fails

See Also:

• registerBrigadier()

Method Details

owningPlugin

public final @NonNull Plugin owningPlugin()

Description copied from interface: PluginHolder

Returns the plugin that owns the manager.

Specified by:

owningPlugin in interface PluginHolder

Returns:

owning plugin

senderMapper

public final @NonNull SenderMapper<CommandSender,C> senderMapper()

Specified by:

senderMapper in interface SenderMapperHolder<CommandSender,C>

hasPermission

public final boolean hasPermission(@NonNull C sender,
 @NonNull String permission)

Specified by:

hasPermission in class CommandManager<C>

splitAliases

@API(status=INTERNAL,
     consumers="org.incendo.cloud.*")
protected final boolean splitAliases()

splitAliases

@API(status=INTERNAL,
     consumers="org.incendo.cloud.*")
protected final void splitAliases(boolean value)

checkBrigadierCompatibility

protected final void checkBrigadierCompatibility()
                                          throws BukkitCommandManager.BrigadierInitializationException

Check whether Brigadier can be used on the server instance

Throws:

BukkitCommandManager.BrigadierInitializationException - An exception is thrown if Brigadier isn't available. The exception will contain the reason for this.

registerBrigadier

public void registerBrigadier()
                       throws BukkitCommandManager.BrigadierInitializationException

Attempts to enable Brigadier command registration through Commodore.

Callers should check for CloudBukkitCapabilities.COMMODORE_BRIGADIER first to avoid exceptions.

Throws:

BukkitCommandManager.BrigadierInitializationException - when the prerequisite capabilities are not present or some other issue occurs during registration of Brigadier support

See Also:

• CommandManager.hasCapability(CloudCapability)

hasBrigadierManager

@API(status=STABLE,
     since="2.0.0")
public boolean hasBrigadierManager()

Specified by:

hasBrigadierManager in interface BrigadierManagerHolder<C,Object>

Returns:

Since:

2.0.0

brigadierManager

@API(status=STABLE,
     since="2.0.0")
public @NonNull CloudBrigadierManager<C,?> brigadierManager()

Specified by:

brigadierManager in interface BrigadierManagerHolder<C,Object>

Returns:

Throws:

BrigadierManagerHolder.BrigadierManagerNotPresent - when hasBrigadierManager() is false

Since:

1.2.0