com.sk89q.intake.context

Class CommandLocals

java.lang.Object

com.sk89q.intake.context.CommandLocals

public class CommandLocals
extends Object

This object holds contextual data for a command execution.

Constructor Summary

Constructors

Constructor and Description
CommandLocals()

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(Object key) Test whether the given key exists.
boolean	containsValue(Object value) Test whether the given value exists.
<T> T	get(Class<T> key) Get an object whose key will be the object's class.
Object	get(Object key) Returns the value specified by the given key.
Object	put(Object key, Object value) Set an contextual value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLocals

public CommandLocals()

Method Detail

containsKey

public boolean containsKey(Object key)

Test whether the given key exists.

Parameters:

key - the key

Returns:

true if the key exists

containsValue

public boolean containsValue(Object value)

Test whether the given value exists.

Parameters:

value - the value

Returns:

true if the value exists

get

@Nullable
public Object get(Object key)

Returns the value specified by the given key.

Parameters:

key - the key

Returns:

the value, which may be null, including when the key doesn't exist

get

@Nullable
public <T> T get(Class<T> key)

Get an object whose key will be the object's class.

Type Parameters:

T - the type of object

Parameters:

key - the key

Returns:

the value

put

@Nullable
public Object put(Object key,
                            Object value)

Set an contextual value.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Throws:

UnsupportedOperationException - if the put operation is not supported by this map

ClassCastException - if the class of the specified key or value prevents it from being stored in this map