Package com.griefdefender.api.permission

Class Context

java.lang.Object

com.griefdefender.api.permission.Context

All Implemented Interfaces:

Map.Entry<String,String>

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

The context that a given service check occurs in.

Instances of a context are designed to function as cache keys, meaning they should be fairly lightweight and not hold references to large objects.

Contexts consist of a "type" (or key) and a "name" (or value).

Constructor Summary

Constructors

Constructor	Description
Context(String type, String name)	Create a new context instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getKey()
String	getName()	Gets the context name.
String	getType()	Gets the context type.
String	getValue()
int	hashCode()
String	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Context

public Context(String type,
 String name)

Create a new context instance.

Parameters:

type - Context type. Must not be null.

name - Context name. Must not be null.

Method Details

getType

public String getType()

Gets the context type.

For example, if the context represented a world, the type would be world

Returns:

The type of item this context represents

getName

public String getName()

Gets the context name.

For example, if the context represented a world, the name would be the name of the world.

Returns:

The specific name of the item involved in this context

getKey

public String getKey()

Specified by:

getKey in interface Map.Entry<String,String>

getValue

public String getValue()

Specified by:

getValue in interface Map.Entry<String,String>

setValue

public String setValue(String value)

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