org.exoplatform.commons.api.settings.data

Class Context

java.lang.Object

org.exoplatform.commons.api.settings.data.Context

All Implemented Interfaces:

Serializable, Cloneable

public class Context
extends Object
implements Cloneable, Serializable

Saves some settings linked to a Context.

See Also:

Serialized Form

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static Context	GLOBAL GLOBAL: Settings should impact all users in the underlying scope.
static Context	USER USER: Each user should be able to save his own settings.

Constructor Summary

Constructors

Constructor and Description
Context(String name, String id)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getId() Gets a context Id.
String	getName()
int	hashCode()
Context	id(String id) Creates a context with a specified Id.

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL

public static final Context GLOBAL

GLOBAL: Settings should impact all users in the underlying scope.

Level API:

Experimental

USER

public static final Context USER

USER: Each user should be able to save his own settings.

Level API:

Experimental

Constructor Detail

Context

public Context(String name,
               String id)

Method Detail

id

public Context id(String id)

Creates a context with a specified Id.

Parameters:

id - The Id that is displayed as username.

Level API:

Experimental

getId

public String getId()

Gets a context Id.

Returns:

Returns "null" if the context is GLOBAL or user Id if the context is USER.

Level API:

Experimental

getName

public String getName()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object