me.lucko.helper.command.context

Class ImmutableCommandContext<T extends org.bukkit.command.CommandSender>

java.lang.Object

me.lucko.helper.command.context.ImmutableCommandContext<T>

All Implemented Interfaces:

CommandContext<T>

public class ImmutableCommandContext<T extends org.bukkit.command.CommandSender>
extends Object
implements CommandContext<T>

Constructor Summary

Constructors

Constructor and Description
ImmutableCommandContext(T sender, String label, String[] args, List<String> aliases)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<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.
T	sender() Gets the sender who executed the command

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.lucko.helper.command.context.CommandContext

reply

Constructor Detail

ImmutableCommandContext

public ImmutableCommandContext(T sender,
                               String label,
                               String[] args,
                               List<String> aliases)

Method Detail

sender

@Nonnull
public T sender()

Description copied from interface: CommandContext

Gets the sender who executed the command

Specified by:

sender in interface CommandContext<T extends org.bukkit.command.CommandSender>

Returns:

the sender who executed the command

args

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

Description copied from interface: CommandContext

Gets an immutable list of the supplied arguments

Specified by:

args in interface CommandContext<T extends org.bukkit.command.CommandSender>

Returns:

an immutable list of the supplied arguments

arg

@Nonnull
public Argument arg(int index)

Description copied from interface: CommandContext

Gets the argument at a the given index

Specified by:

arg in interface CommandContext<T extends org.bukkit.command.CommandSender>

Parameters:

index - the index

Returns:

the argument

rawArg

@Nullable
public String rawArg(int index)

Description copied from interface: CommandContext

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

Specified by:

rawArg in interface CommandContext<T extends org.bukkit.command.CommandSender>

Parameters:

index - the index

Returns:

the argument, or null if one was not present

label

@Nonnull
public String label()

Description copied from interface: CommandContext

Gets the command label which was used to execute this command

Specified by:

label in interface CommandContext<T extends org.bukkit.command.CommandSender>

Returns:

the command label which was used to execute this command

aliases

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

Description copied from interface: CommandContext

Gets the aliases of the command.

Specified by:

aliases in interface CommandContext<T extends org.bukkit.command.CommandSender>

Returns:

the aliases of the command