Package com.github.siroshun09.mccommand.bukkit

Class BukkitCommandFactory

java.lang.Object

com.github.siroshun09.mccommand.bukkit.BukkitCommandFactory

public final class BukkitCommandFactory
extends Object

The class for registering commands to Bukkit.

Method Summary

Modifier and Type	Method	Description
static void	register(@NotNull PluginCommand target, @NotNull Command command)	Registers the command.
static void	registerAsync(@NotNull PluginCommand target, @NotNull Command command)	Registers the command.
static void	registerAsync(@NotNull PluginCommand target, @NotNull Command command, @NotNull Executor executor)	Registers the command.
static void	registerAsyncIfExists(@NotNull JavaPlugin sourcePlugin, @NotNull Command command)	Searches for PluginCommand that is named as Command.getName() and register the command if it exists.
static void	registerAsyncIfExists(@NotNull JavaPlugin sourcePlugin, @NotNull Command command, @NotNull Executor executor)	Searches for PluginCommand that is named as Command.getName() and register the command if it exists.
static void	registerIfExists(@NotNull JavaPlugin sourcePlugin, @NotNull Command command)	Searches for PluginCommand that is named as Command.getName() and register the command if it exists.

Methods inherited from class java.lang.Object

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

Method Detail

register

public static void register(@NotNull
                            @NotNull PluginCommand target,
                            @NotNull
                            @NotNull Command command)

Registers the command.

Parameters:

target - the PluginCommand

command - the command to register

registerIfExists

public static void registerIfExists(@NotNull
                                    @NotNull JavaPlugin sourcePlugin,
                                    @NotNull
                                    @NotNull Command command)

Searches for PluginCommand that is named as Command.getName() and register the command if it exists.

Parameters:

sourcePlugin - the plugin to search for the command

command - the command to register

registerAsync

public static void registerAsync(@NotNull
                                 @NotNull PluginCommand target,
                                 @NotNull
                                 @NotNull Command command)

Registers the command.

If you register a command with this method, it will be executed asynchronously.

Note:

The tab completion will execute on main thread.

Parameters:

target - the PluginCommand

command - the command to register

registerAsyncIfExists

public static void registerAsyncIfExists(@NotNull
                                         @NotNull JavaPlugin sourcePlugin,
                                         @NotNull
                                         @NotNull Command command)

Searches for PluginCommand that is named as Command.getName() and register the command if it exists.

Parameters:

sourcePlugin - the plugin to search for the command

command - the command to register

See Also:

registerAsync(PluginCommand, Command)

registerAsync

public static void registerAsync(@NotNull
                                 @NotNull PluginCommand target,
                                 @NotNull
                                 @NotNull Command command,
                                 @NotNull
                                 @NotNull Executor executor)

Registers the command.

If you register a command with this method, it will be executed asynchronously.

Note:

The tab completion will execute on main thread.

Parameters:

target - the PluginCommand

command - the command to register

executor - the executor to run command

registerAsyncIfExists

public static void registerAsyncIfExists(@NotNull
                                         @NotNull JavaPlugin sourcePlugin,
                                         @NotNull
                                         @NotNull Command command,
                                         @NotNull
                                         @NotNull Executor executor)

Searches for PluginCommand that is named as Command.getName() and register the command if it exists.

Parameters:

sourcePlugin - the plugin to search for the command

command - the command to register

executor - the executor to run command

See Also:

registerAsync(PluginCommand, Command)