Package sawfowl.commandpack.api.commands.parameterized

Interface ParameterizedCommand

All Superinterfaces:

CommandExecutor, PluginCommand

All Known Subinterfaces:

ParameterizedPlayerCommand

public interface ParameterizedCommand
extends PluginCommand, CommandExecutor

This interface is designed to simplify the creation of commands and add additional functionality to them.

Method Summary

Modifier and Type	Method	Description
Command.Parameterized	build()	Command building.
default Command.Builder	builder()	Command builder. This builder adds permission.
default Command.Builder	builderNoPerm()	Command builder. This builder adds arguments if they exist.
default CommandResult	execute(CommandContext context)	Check the command arguments and determine who is using the command.
void	execute(CommandContext context, Audience src, Locale locale, boolean isPlayer)	Command code execution.
default Command.Parameterized	fastBuild()	Command building. Automatically applies permission and arguments if available.
default <T> Optional<T>	getArgument(CommandContext context, Class<T> object, String arg)	Getting an object from a command argument.
default <T> Optional<T>	getArgument(CommandContext context, Parameter.Value<T> value)	Getting an object from a command argument.
default Optional<Boolean>	getBoolean(CommandContext context, String arg)
default boolean	getBoolean(CommandContext context, String arg, boolean def)
default Optional<ServerLocation>	getLocation(CommandContext context)
default Optional<ServerPlayer>	getPlayer(CommandContext context)
Map<String,ParameterSettings>	getSettingsMap()	Map of arguments. The argument can be optional for the player and mandatory for the console.
default Optional<String>	getString(CommandContext context, String arg)
default String	getString(CommandContext context, String arg, String def)
default Optional<String>	getUser(CommandContext context)
default boolean	onlyPlayer()
default void	register(RegisterCommandEvent<Command.Parameterized> event)	Command registration.

Methods inherited from interface sawfowl.commandpack.api.commands.PluginCommand

checkCooldown, command, delay, economy, exception, exception, exception, exception, exception, exception, exception, exception, getCommandSettings, getComponent, getComponent, getComponent, getContainer, getCooldowns, getListTexts, getLocale, getPluginLocale, getText, getText, isEnable, permission, sendPaginationList, success, text, text, timeFormat, trackingName

Method Details

execute

void execute(CommandContext context,
 Audience src,
 Locale locale,
 boolean isPlayer)
      throws CommandException

Command code execution.

Throws:

CommandException

getSettingsMap

Map<String,ParameterSettings> getSettingsMap()

Map of arguments.
The argument can be optional for the player and mandatory for the console.

build

Command.Parameterized build()

Command building.

execute

default CommandResult execute(CommandContext context)
                       throws CommandException

Check the command arguments and determine who is using the command.

Specified by:

execute in interface CommandExecutor

Throws:

CommandException

onlyPlayer

default boolean onlyPlayer()

register

default void register(RegisterCommandEvent<Command.Parameterized> event)

Command registration.

builder

default Command.Builder builder()

Command builder.
This builder adds permission.

builderNoPerm

default Command.Builder builderNoPerm()

Command builder.
This builder adds arguments if they exist.

fastBuild

default Command.Parameterized fastBuild()

Command building.
Automatically applies permission and arguments if available.

getPlayer

default Optional<ServerPlayer> getPlayer(CommandContext context)

getUser

default Optional<String> getUser(CommandContext context)

getBoolean

default Optional<Boolean> getBoolean(CommandContext context,
 String arg)

getBoolean

default boolean getBoolean(CommandContext context,
 String arg,
 boolean def)

getString

default Optional<String> getString(CommandContext context,
 String arg)

getString

default String getString(CommandContext context,
 String arg,
 String def)

getLocation

default Optional<ServerLocation> getLocation(CommandContext context)

getArgument

default <T> Optional<T> getArgument(CommandContext context,
 Class<T> object,
 String arg)

Getting an object from a command argument.

getArgument

default <T> Optional<T> getArgument(CommandContext context,
 Parameter.Value<T> value)

Getting an object from a command argument.