Package sawfowl.commandpack.api.commands.raw

Interface RawCommand

All Superinterfaces:

Command, Command.Raw, PluginCommand

All Known Subinterfaces:

RawPlayerCommand

public interface RawCommand
extends PluginCommand, Command.Raw

This interface is designed to simplify the creation of RawSettings commands.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.command.Command

Command.Builder, Command.Parameterized, Command.Raw

Method Summary

Modifier and Type	Method	Description
default boolean	canExecute(CommandCause cause)	Determining who can use the command.
default String[]	checkArguments(CommandCause cause, String[] args, boolean isPlayer, Locale locale)
default String[]	checkChildAndArguments(CommandCause cause, String[] args, boolean isPlayer, Locale locale)
default CommandTreeNode.Root	commandTree()
default List<CommandCompletion>	complete(CommandCause cause, ArgumentReader.Mutable arguments)
default List<CommandCompletion>	completeArgs(CommandCause cause, List<String> args, String currentInput)	Auto-complete command arguments.
default List<CommandCompletion>	completeChild(CommandCause cause, List<String> args, String currentInput)
default boolean	containsArgs()
default boolean	containsChild()
default boolean	enableAutoComplete()	If `false`, the player will not get a list of available command arguments.
default CommandException	exceptionAppendUsage(CommandCause cause, Locale locale, Object[] localePath)
default CommandException	exceptionAppendUsage(CommandCause cause, Component text)
Component	extendedDescription(Locale locale)
default Optional<Component>	extendedDescription(CommandCause cause)
default <T> Optional<T>	getArgument(Class<T> clazz, String[] args, int cursor)	Deprecated.
default <T> Optional<T>	getArgument(Class<T> clazz, List<String> args, int cursor)	Deprecated.
default <T> Optional<T>	getArgument(Class<T> clazz, CommandCause cause, String[] args, int cursor)	Getting an object from a command argument.
Map<Integer,RawArgument<?>>	getArguments()	Map of command arguments.
default Optional<BigDecimal>	getBigDecimal(String[] args, int cursor)
default Optional<BigDecimal>	getBigDecimal(String[] args, CommandCause cause, int cursor)
default Optional<Boolean>	getBoolean(String[] args, int cursor)
default Optional<Boolean>	getBoolean(String[] args, CommandCause cause, int cursor)
Map<String,RawCommand>	getChildExecutors()	Subcommand map. The subcommands automatically get to the first place when the arguments are autocomplete.
default Optional<Currency>	getCurrency(String[] args, int cursor)
default Optional<Currency>	getCurrency(String[] args, CommandCause cause, int cursor)
default Optional<Double>	getDouble(String[] args, int cursor)
default Optional<Double>	getDouble(String[] args, CommandCause cause, int cursor)
default Optional<Duration>	getDurationArg(String[] args, int cursor, Locale locale)
default Optional<Duration>	getDurationArg(String[] args, CommandCause cause, int cursor, Locale locale)
default List<CommandCompletion>	getEmptyCompletion()	No need to Override any more.
default Optional<EnchantmentType>	getEnchantmentType(String[] args, int cursor)
default Optional<EnchantmentType>	getEnchantmentType(String[] args, CommandCause cause, int cursor)
default Optional<Integer>	getInteger(String[] args, int cursor)
default Optional<Integer>	getInteger(String[] args, CommandCause cause, int cursor)
default Optional<Locale>	getLocale(String[] args, int cursor)
default Optional<Locale>	getLocale(String[] args, CommandCause cause, int cursor)
default Optional<Long>	getLong(String[] args, int cursor)
default Optional<Long>	getLong(String[] args, CommandCause cause, int cursor)
default Optional<ServerPlayer>	getPlayer(String[] args, int cursor)
default Optional<ServerPlayer>	getPlayer(String[] args, CommandCause cause, int cursor)
default Optional<String>	getString(String[] args, int cursor)
default Optional<String>	getString(String[] args, CommandCause cause, int cursor)
default Optional<ServerWorld>	getWorld(String[] args, int cursor)
default Optional<ServerWorld>	getWorld(String[] args, CommandCause cause, int cursor)
default Optional<WorldType>	getWorldType(String[] args, int cursor)
default Optional<WorldType>	getWorldType(String[] args, CommandCause cause, int cursor)
default Optional<Double>	parseDouble(String arg)	Deprecated.
default Optional<Duration>	parseDuration(String s, Locale locale)	Convert string to object Duration
default Optional<Integer>	parseInt(String arg)	Deprecated.
void	process(CommandCause cause, Audience audience, Locale locale, boolean isPlayer, String[] args, ArgumentReader.Mutable arguments)	Command code execution.
default CommandResult	process(CommandCause cause, ArgumentReader.Mutable arguments)	Checks for child commands and who activated the command.
default void	register(RegisterCommandEvent<Command.Raw> event)	Command registration.
Component	shortDescription(Locale locale)
default Optional<Component>	shortDescription(CommandCause cause)

Methods inherited from interface org.spongepowered.api.command.Command

help, usage

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

process

void process(CommandCause cause,
 Audience audience,
 Locale locale,
 boolean isPlayer,
 String[] args,
 ArgumentReader.Mutable arguments)
      throws CommandException

Command code execution.

Throws:

CommandException

shortDescription

Component shortDescription(Locale locale)

extendedDescription

Component extendedDescription(Locale locale)

getChildExecutors

Map<String,RawCommand> getChildExecutors()

Subcommand map.
The subcommands automatically get to the first place when the arguments are autocomplete.

getArguments

Map<Integer,RawArgument<?>> getArguments()

Map of command arguments.

enableAutoComplete

default boolean enableAutoComplete()

If `false`, the player will not get a list of available command arguments.
Regardless of the return value, the player will receive variants of the child commands.
This parameter will be ignored when overriding the complete(CommandCause, Mutable) method.

commandTree

default CommandTreeNode.Root commandTree()

Specified by:

commandTree in interface Command.Raw

process

default CommandResult process(CommandCause cause,
 ArgumentReader.Mutable arguments)
                       throws CommandException

Checks for child commands and who activated the command.

Specified by:

process in interface Command

Throws:

CommandException

complete

default List<CommandCompletion> complete(CommandCause cause,
 ArgumentReader.Mutable arguments)
                                  throws CommandException

Specified by:

complete in interface Command

Throws:

CommandException

checkChildAndArguments

default String[] checkChildAndArguments(CommandCause cause,
 String[] args,
 boolean isPlayer,
 Locale locale)
                                 throws CommandException

Throws:

CommandException

checkArguments

default String[] checkArguments(CommandCause cause,
 String[] args,
 boolean isPlayer,
 Locale locale)
                         throws CommandException

Throws:

CommandException

completeChild

default List<CommandCompletion> completeChild(CommandCause cause,
 List<String> args,
 String currentInput)

completeArgs

default List<CommandCompletion> completeArgs(CommandCause cause,
 List<String> args,
 String currentInput)

Auto-complete command arguments.

shortDescription

default Optional<Component> shortDescription(CommandCause cause)

Specified by:

shortDescription in interface Command

extendedDescription

default Optional<Component> extendedDescription(CommandCause cause)

Specified by:

extendedDescription in interface Command

canExecute

default boolean canExecute(CommandCause cause)

Determining who can use the command.

Specified by:

canExecute in interface Command

register

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

Command registration.

parseInt

@Deprecated
default Optional<Integer> parseInt(String arg)

Deprecated.

An attempt to convert a string to an integer.

parseDouble

@Deprecated
default Optional<Double> parseDouble(String arg)

Deprecated.

An attempt to convert a string to a fractional number.

exceptionAppendUsage

default CommandException exceptionAppendUsage(CommandCause cause,
 Component text)
                                       throws CommandException

Throws:

CommandException

exceptionAppendUsage

default CommandException exceptionAppendUsage(CommandCause cause,
 Locale locale,
 Object[] localePath)
                                       throws CommandException

Throws:

CommandException

getWorld

default Optional<ServerWorld> getWorld(String[] args,
 int cursor)

getWorldType

default Optional<WorldType> getWorldType(String[] args,
 int cursor)

getPlayer

default Optional<ServerPlayer> getPlayer(String[] args,
 int cursor)

getEnchantmentType

default Optional<EnchantmentType> getEnchantmentType(String[] args,
 int cursor)

getString

default Optional<String> getString(String[] args,
 int cursor)

getBoolean

default Optional<Boolean> getBoolean(String[] args,
 int cursor)

getInteger

default Optional<Integer> getInteger(String[] args,
 int cursor)

getLong

default Optional<Long> getLong(String[] args,
 int cursor)

getDouble

default Optional<Double> getDouble(String[] args,
 int cursor)

getBigDecimal

default Optional<BigDecimal> getBigDecimal(String[] args,
 int cursor)

getLocale

default Optional<Locale> getLocale(String[] args,
 int cursor)

getCurrency

default Optional<Currency> getCurrency(String[] args,
 int cursor)

getDurationArg

default Optional<Duration> getDurationArg(String[] args,
 int cursor,
 Locale locale)
                                   throws CommandException

Throws:

CommandException

getWorld

default Optional<ServerWorld> getWorld(String[] args,
 CommandCause cause,
 int cursor)

getWorldType

default Optional<WorldType> getWorldType(String[] args,
 CommandCause cause,
 int cursor)

getPlayer

default Optional<ServerPlayer> getPlayer(String[] args,
 CommandCause cause,
 int cursor)

getEnchantmentType

default Optional<EnchantmentType> getEnchantmentType(String[] args,
 CommandCause cause,
 int cursor)

getString

default Optional<String> getString(String[] args,
 CommandCause cause,
 int cursor)

getBoolean

default Optional<Boolean> getBoolean(String[] args,
 CommandCause cause,
 int cursor)

getInteger

default Optional<Integer> getInteger(String[] args,
 CommandCause cause,
 int cursor)

getLong

default Optional<Long> getLong(String[] args,
 CommandCause cause,
 int cursor)

getDouble

default Optional<Double> getDouble(String[] args,
 CommandCause cause,
 int cursor)

getBigDecimal

default Optional<BigDecimal> getBigDecimal(String[] args,
 CommandCause cause,
 int cursor)

getLocale

default Optional<Locale> getLocale(String[] args,
 CommandCause cause,
 int cursor)

getCurrency

default Optional<Currency> getCurrency(String[] args,
 CommandCause cause,
 int cursor)

getDurationArg

default Optional<Duration> getDurationArg(String[] args,
 CommandCause cause,
 int cursor,
 Locale locale)
                                   throws CommandException

Throws:

CommandException

getArgument

@Deprecated
default <T> Optional<T> getArgument(Class<T> clazz,
 String[] args,
 int cursor)

Deprecated.

Getting an object from a command argument. Use getArgument(Class, CommandCause, String[], int)

Type Parameters:

T - - The type of the returned object.

Parameters:

clazz - - The class of the returned object.

args - - All command arguments.

cursor - - The argument number of the command.

Returns:

Optional

getArgument

@Deprecated
default <T> Optional<T> getArgument(Class<T> clazz,
 List<String> args,
 int cursor)

Deprecated.

Use getArgument(Class, CommandCause, String[], int)

getArgument

default <T> Optional<T> getArgument(Class<T> clazz,
 CommandCause cause,
 String[] args,
 int cursor)

Getting an object from a command argument.

Type Parameters:

T - - The type of the returned object.

Parameters:

clazz - - The class of the returned object.

args - - All command arguments.

cursor - - The argument number of the command.

Returns:

Optional

parseDuration

default Optional<Duration> parseDuration(String s,
 Locale locale)
                                  throws CommandException

Convert string to object Duration

Throws:

CommandException

getEmptyCompletion

default List<CommandCompletion> getEmptyCompletion()

No need to Override any more.

containsChild

default boolean containsChild()

containsArgs

default boolean containsArgs()