org.exoplatform.commons.api.settings.data

Enum Context

java.lang.Object

java.lang.Enum<Context>

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

All Implemented Interfaces:

Serializable, Comparable<Context>

public enum Context
extends Enum<Context>

Saves some settings linked to a Context.

Level API:

Experimental

Enum Constant Summary

Enum Constants

Enum Constant and Description
GLOBAL GLOBAL: Settings should impact all users in the underlying scope.
USER USER: Each user should be able to save his own settings.

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Gets a context Id.
Context	id(String id) Creates a context with a specified Id.
static Context	valueOf(String name) Returns the enum constant of this type with the specified name.
static Context[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant 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

Method Detail

values

public static Context[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Context c : Context.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Context valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

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