org.spongepowered.api.command.args

Class CommandContext

java.lang.Object

org.spongepowered.api.command.args.CommandContext

public final class CommandContext
extends Object

Context that a command is executed in. This object stores parsed arguments from other commands

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommandContext.Snapshot A snapshot of a CommandContext.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAB_COMPLETION The argument key to indicate that a tab completion is taking place.
static String	TARGET_BLOCK_ARG The argument key for a target block position that may be present during tab completion, of type Location<World>.

Constructor Summary

Constructors

Constructor and Description
CommandContext() Create a new empty CommandContext.

Method Summary

Modifier and Type	Method and Description
void	addFlag(String key) Defines the flag as being present when parsing this context.
void	addFlag(Text key) Defines the flag as being present when parsing this context.
void	applySnapshot(CommandContext.Snapshot snapshot) Resets a CommandContext to a previous state using a previously created CommandContext.Snapshot.
void	checkPermission(CommandSource commander, String permission) Perform a permissions check, throwing an exception if the required permissions are not present.
CommandContext.Snapshot	createSnapshot() Gets a snapshot of the data inside this context to allow it to be restored later.
<T> Collection<T>	getAll(String key) Gets all values for the given argument.
<T> Collection<T>	getAll(Text key) Gets all values for the given argument.
<T> Optional<T>	getOne(String key) Gets the value for the given key if the key has only one value.
<T> Optional<T>	getOne(Text key) Gets the value for the given key if the key has only one value.
boolean	hasAny(String key) Returns whether this context has any value for the given argument key.
boolean	hasAny(Text key) Returns whether this context has any value for the given argument key.
boolean	hasFlag(String key) Returns whether the given flag has been defined in this context.
boolean	hasFlag(Text key) Returns whether the given flag has been defined in this context.
void	putArg(String key, Object value) Insert an argument into this context.
void	putArg(Text key, Object value) Insert an argument into this context.
<T> T	requireOne(String key) Gets the value for the given key if the key has only one value, throws an exception otherwise.
<T> T	requireOne(Text key) Gets the value for the given key if the key has only one value, throws an exception otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

TARGET_BLOCK_ARG

public static final String TARGET_BLOCK_ARG

The argument key for a target block position that may be present during tab completion, of type Location<World>.

See Also:

Constant Field Values

TAB_COMPLETION

public static final String TAB_COMPLETION

The argument key to indicate that a tab completion is taking place.

See Also:

Constant Field Values

Constructor Detail

CommandContext

public CommandContext()

Create a new empty CommandContext.

Method Detail

getAll

public <T> Collection<T> getAll(String key)

Gets all values for the given argument. May return an empty list if no values are present.

Type Parameters:

T - the type of value to get

Parameters:

key - The key to get values for

Returns:

the collection of all values

getAll

public <T> Collection<T> getAll(Text key)

Gets all values for the given argument. May return an empty list if no values are present.

Type Parameters:

T - the type of value to get

Parameters:

key - The key to get values for

Returns:

the collection of all values

getOne

public <T> Optional<T> getOne(String key)

Gets the value for the given key if the key has only one value.

An empty Optional indicates that there are either zero or more than one values for the given key. Use hasAny(Text) to verify which.

Type Parameters:

T - the expected type of the argument

Parameters:

key - the key to get

Returns:

the argument

getOne

public <T> Optional<T> getOne(Text key)

Gets the value for the given key if the key has only one value.

An empty Optional indicates that there are either zero or more than one values for the given key. Use hasAny(Text) to verify which.

Type Parameters:

T - the expected type of the argument

Parameters:

key - the key to get

Returns:

the argument

requireOne

public <T> T requireOne(String key)
                 throws NoSuchElementException,
                        IllegalArgumentException,
                        ClassCastException

Gets the value for the given key if the key has only one value, throws an exception otherwise.

Type Parameters:

T - the expected type of the argument

Parameters:

key - the key to get

Returns:

the argument

Throws:

NoSuchElementException - if there is no element with the associated key

IllegalArgumentException - if there are more than one element associated with the key (thus, the argument is illegal in this context)

ClassCastException - if the element type is not what is expected by the caller

requireOne

public <T> T requireOne(Text key)
                 throws NoSuchElementException,
                        IllegalArgumentException,
                        ClassCastException

Gets the value for the given key if the key has only one value, throws an exception otherwise.

Type Parameters:

T - the expected type of the argument

Parameters:

key - the key to get

Returns:

the argument

Throws:

NoSuchElementException - if there is no element with the associated key

IllegalArgumentException - if there are more than one element associated with the key (thus, the argument is illegal in this context)

ClassCastException - if the element type is not what is expected

putArg

public void putArg(String key,
                   Object value)

Insert an argument into this context.

Parameters:

key - the key to store the arg under

value - the value for this argument

putArg

public void putArg(Text key,
                   Object value)

Insert an argument into this context.

Parameters:

key - the key to store the arg under

value - the value for this argument

addFlag

public void addFlag(String key)

Defines the flag as being present when parsing this context.

Parameters:

key - the key for the flag defined

addFlag

public void addFlag(Text key)

Defines the flag as being present when parsing this context.

Parameters:

key - the key for the flag defined

checkPermission

public void checkPermission(CommandSource commander,
                            String permission)
                     throws CommandException

Perform a permissions check, throwing an exception if the required permissions are not present.

Parameters:

commander - the source to check against

permission - The permission to check

Throws:

CommandException - if the source does not have permission

hasAny

public boolean hasAny(String key)

Returns whether this context has any value for the given argument key.

Parameters:

key - The key to look up

Returns:

whether there are any values present

hasAny

public boolean hasAny(Text key)

Returns whether this context has any value for the given argument key.

Parameters:

key - The key to look up

Returns:

whether there are any values present

hasFlag

public boolean hasFlag(String key)

Returns whether the given flag has been defined in this context.

Parameters:

key - The key to look up

Returns:

whether the flag is defined

hasFlag

public boolean hasFlag(Text key)

Returns whether the given flag has been defined in this context.

Parameters:

key - The key to look up

Returns:

whether the flag is defined

createSnapshot

public CommandContext.Snapshot createSnapshot()

Gets a snapshot of the data inside this context to allow it to be restored later.

This is only guaranteed to create a shallow copy of the backing store. If any value is mutable, any changes to that value will be reflected in this snapshot. It is therefore not recommended that you keep this snapshot around for longer than is necessary.

Returns:

The CommandContext.Snapshot containing the current state of the CommandContext

applySnapshot

public void applySnapshot(CommandContext.Snapshot snapshot)

Resets a CommandContext to a previous state using a previously created CommandContext.Snapshot.

Parameters:

snapshot - The CommandContext.Snapshot to restore this context with