com.mrivanplays.commandworker.core

Interface CommandManager<S>

Type Parameters:

S - sender type

All Known Implementing Classes:

AbstractCommandManager

public interface CommandManager<S>

Represents a manager of all the registered commands.

Method Summary

Modifier and Type	Method and Description
default boolean	aliasesFree(@NotNull List<RegisteredCommand<S>> commands, @NotNull String[] aliases) Returns whenever the aliases are free in the specified command list.
static @NotNull String[]	getAliases(@NotNull String fallbackPrefix, String... aliases) Creates the aliases with the fallback prefix bukkit is creating normally, returns all the aliases with which command x would get registered on bukkit.
@NotNull List<RegisteredCommand<S>>	getRegisteredCommands() Returns unmodifiable copy of the commands, registered and held by this command manager.
boolean	isBrigadierSupported() Returns whether or not brigadier is supported for this command manager.
void	register(@NotNull Command<S> command, @Nullable Predicate<S> permissionCheck, String... aliases) Registers the specified command with the identifying aliases, giving option to check for permissions.
default void	register(@NotNull Command<S> command, String... aliases) Registers the specified command with the identifying aliases.
void	setShouldFallback(boolean shouldFallback)
boolean	shouldFallback() Returns whether or not this command manager should fallback to the implemented on platform's normal registering technique when brigadier isn't supported.

Method Detail

register

default void register(@NotNull
                      @NotNull Command<S> command,
                      @NotNull
                      String... aliases)

Registers the specified command with the identifying aliases. The registration will fallback to bukkit if brigadier isn't present.

Parameters:

command - the command you want to register

aliases - aliases

register

void register(@NotNull
              @NotNull Command<S> command,
              @Nullable
              @Nullable Predicate<S> permissionCheck,
              @NotNull
              String... aliases)

Registers the specified command with the identifying aliases, giving option to check for permissions. The registration will fallback to bukkit if brigadier isn't present.

Parameters:

command - the command you want to register

permissionCheck - permission check

aliases - aliases

isBrigadierSupported

boolean isBrigadierSupported()

Returns whether or not brigadier is supported for this command manager.

Returns:

true if brigadier is supported, false otherwise

shouldFallback

boolean shouldFallback()

Returns whether or not this command manager should fallback to the implemented on platform's normal registering technique when brigadier isn't supported.

Returns:

true if should fallback, false otherwise

setShouldFallback

void setShouldFallback(boolean shouldFallback)

Parameters:

shouldFallback - value

See Also:

shouldFallback()

getRegisteredCommands

@NotNull
@NotNull List<RegisteredCommand<S>> getRegisteredCommands()

Returns unmodifiable copy of the commands, registered and held by this command manager.

Returns:

registered commands

aliasesFree

default boolean aliasesFree(@NotNull
                            @NotNull List<RegisteredCommand<S>> commands,
                            @NotNull
                            @NotNull String[] aliases)

Returns whenever the aliases are free in the specified command list.

Parameters:

commands - commands

aliases - aliases

Returns:

true if aliases free, false otherwise

getAliases

@NotNull
static @NotNull String[] getAliases(@NotNull
                                             @NotNull String fallbackPrefix,
                                             @NotNull
                                             String... aliases)

Creates the aliases with the fallback prefix bukkit is creating normally, returns all the aliases with which command x would get registered on bukkit.

Parameters:

fallbackPrefix - prefix

aliases - normally specified aliases

Returns:

all the aliases