org.eclipse.stardust.engine.core.preferences
Enum PreferenceScope

java.lang.Object
  extended by java.lang.Enum<PreferenceScope>
      extended by org.eclipse.stardust.engine.core.preferences.PreferenceScope
All Implemented Interfaces:
Serializable, Comparable<PreferenceScope>

public enum PreferenceScope
extends Enum<PreferenceScope>

A PreferenceScope defines scoping of preferences. The granularity of scopes is divided into per Partition, per UserRealm and per User.

By using the DEFAULT scope there is the option to retrieve default values provided via SPI.

Author:
sauer, roland.stamm

Enum Constant Summary
DEFAULT
          The DEFAULT scope is used to read default values supplied by the IStaticConfigurationProvider SPI implementing providers.
PARTITION
          The PARTITION scope is used to address preferences on partition level.
REALM
          The REALM scope is used to address preferences on realm level.
USER
          The USER scope is used to address preferences on user level.
 
Method Summary
static PreferenceScope valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PreferenceScope[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DEFAULT

public static final PreferenceScope DEFAULT
The DEFAULT scope is used to read default values supplied by the IStaticConfigurationProvider SPI implementing providers.

See Also:
IStaticConfigurationProvider

PARTITION

public static final PreferenceScope PARTITION
The PARTITION scope is used to address preferences on partition level. These preferences are accessible for all users on the same partition.


REALM

public static final PreferenceScope REALM
The REALM scope is used to address preferences on realm level. These preferences are saved per UserRealm, meaning only Users on the same UserRealm can access the same set of preferences.


USER

public static final PreferenceScope USER
The USER scope is used to address preferences on user level. These preferences are saved per User. No other Users except Administrators have access to them.

Method Detail

values

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

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

valueOf

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


Copyright © 2017 Eclipse Stardust. All Rights Reserved.