me.lucko.helper.command.context

Interface CommandContext<T extends org.bukkit.command.CommandSender>

Type Parameters:

T - the sender type

All Known Implementing Classes:

ImmutableCommandContext

public interface CommandContext<T extends org.bukkit.command.CommandSender>

Represents the context for a given command execution

Method Summary

Modifier and Type	Method and Description
List<String>	aliases() Gets the aliases of the command.
Argument	arg(int index) Gets the argument at a the given index
com.google.common.collect.ImmutableList<String>	args() Gets an immutable list of the supplied arguments
String	label() Gets the command label which was used to execute this command
String	rawArg(int index) Gets the argument at the given index.
default void	reply(String... message) Sends a message to the sender().
T	sender() Gets the sender who executed the command

Method Detail

sender

@Nonnull
T sender()

Gets the sender who executed the command

Returns:

the sender who executed the command

reply

default void reply(String... message)

Sends a message to the sender().

Parameters:

message - the message to send

args

@Nonnull
com.google.common.collect.ImmutableList<String> args()

Gets an immutable list of the supplied arguments

Returns:

an immutable list of the supplied arguments

arg

@Nonnull
Argument arg(int index)

Gets the argument at a the given index

Parameters:

index - the index

Returns:

the argument

rawArg

@Nullable
String rawArg(int index)

Gets the argument at the given index. Returns null if no argument is present at that index.

Parameters:

index - the index

Returns:

the argument, or null if one was not present

label

@Nonnull
String label()

Gets the command label which was used to execute this command

Returns:

the command label which was used to execute this command

aliases

@Nonnull
List<String> aliases()

Gets the aliases of the command.

Returns:

the aliases of the command