org.uberfire.preferences.shared.impl

Enum DefaultScopes

java.lang.Object

java.lang.Enum<DefaultScopes>

org.uberfire.preferences.shared.impl.DefaultScopes

All Implemented Interfaces:

Serializable, Comparable<DefaultScopes>

public enum DefaultScopes
extends Enum<DefaultScopes>

Definition of default scope types that can be used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_USERS Scope type responsible to store preferences for all users.
COMPONENT Scope type responsible to store preferences separately for each component.
ENTIRE_APPLICATION Scope type responsible to store preferences for the entire application.
USER Scope type responsible to store preferences separately for each username.

Method Summary

Modifier and Type	Method and Description
String	type()
static DefaultScopes	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultScopes[]	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

ALL_USERS

public static final DefaultScopes ALL_USERS

Scope type responsible to store preferences for all users.

ENTIRE_APPLICATION

public static final DefaultScopes ENTIRE_APPLICATION

Scope type responsible to store preferences for the entire application.

COMPONENT

public static final DefaultScopes COMPONENT

Scope type responsible to store preferences separately for each component.

USER

public static final DefaultScopes USER

Scope type responsible to store preferences separately for each username.

Method Detail

values

public static DefaultScopes[] 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 (DefaultScopes c : DefaultScopes.values())
    System.out.println(c);

Returns:

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

valueOf

public static DefaultScopes 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

type

public String type()