org.spongepowered.api.service.context

Class Context

java.lang.Object

org.spongepowered.api.service.context.Context

All Implemented Interfaces:

Map.Entry<String,String>

public final class Context
extends Object
implements Map.Entry<String,String>

Encapsulates a single attribute about the state or circumstances of a Contextual.

A Contextual's overall "context" is made up multiple Context instances, usually stored together in a Set.

Any single Context attribute is made up of a key and a value. The key represents the type of context, and the value is just that, the value associated with the key. Some common/shared keys are expressed as static fields on this class for convenience.

For example, a context encapsulating a Contextuals circumstance within a given world would have key of "world" and a value equal to the name of the world.

Context is immutable. The setValue(String) inherited from Map.Entry is not supported.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIMENSION_KEY
static String	LOCAL_HOST_KEY
static String	LOCAL_IP_KEY
static String	LOCAL_PORT_KEY
static String	REMOTE_IP_KEY
static String	USER_KEY
static String	WORLD_KEY

Constructor Summary

Constructors

Constructor and Description
Context(String key, String value) Create a new context instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getKey() Gets the context key.
String	getName() Deprecated. This method name is misleading - contexts only have a "key" and "value". It is not immediately clear what "name" relates to. (it could reasonably be either key or value)
String	getType() Deprecated. The presence of this method is misleading - the context "type" is the same value as the "key". They are not separate attributes, as the presence of two distinct methods would otherwise suggest.
String	getValue() Gets the context value.
int	hashCode()
String	setValue(String value) Deprecated.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Field Detail

USER_KEY

public static final String USER_KEY

See Also:

Constant Field Values

WORLD_KEY

public static final String WORLD_KEY

See Also:

Constant Field Values

DIMENSION_KEY

public static final String DIMENSION_KEY

See Also:

Constant Field Values

REMOTE_IP_KEY

public static final String REMOTE_IP_KEY

See Also:

Constant Field Values

LOCAL_HOST_KEY

public static final String LOCAL_HOST_KEY

See Also:

Constant Field Values

LOCAL_IP_KEY

public static final String LOCAL_IP_KEY

See Also:

Constant Field Values

LOCAL_PORT_KEY

public static final String LOCAL_PORT_KEY

See Also:

Constant Field Values

Constructor Detail

Context

public Context(String key,
               String value)

Create a new context instance.

Parameters:

key - Context key. Must not be null.

value - Context value. Must not be null.

Method Detail

getKey

public String getKey()

Gets the context key.

Specified by:

getKey in interface Map.Entry<String,String>

Returns:

The key

getValue

public String getValue()

Gets the context value.

Specified by:

getValue in interface Map.Entry<String,String>

Returns:

The value

getType

@Deprecated
public String getType()

Deprecated. The presence of this method is misleading - the context "type" is the same value as the "key". They are not separate attributes, as the presence of two distinct methods would otherwise suggest.

Alias method for getKey().

Returns:

The type of the context

getName

@Deprecated
public String getName()

Deprecated. This method name is misleading - contexts only have a "key" and "value". It is not immediately clear what "name" relates to. (it could reasonably be either key or value)

Alias method for getValue().

Returns:

The specific name of the item involved in this context

setValue

@Deprecated
public String setValue(String value)

Deprecated.

Specified by:

setValue in interface Map.Entry<String,String>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map.Entry<String,String>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map.Entry<String,String>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object