com.atlassian.sal.api.features
Enum FeatureKeyScope

java.lang.Object
  java.lang.Enum<FeatureKeyScope>
      com.atlassian.sal.api.features.FeatureKeyScope

All Implemented Interfaces:

Serializable, Comparable<FeatureKeyScope>

public enum FeatureKeyScope
extends Enum<FeatureKeyScope>

The scope of an enabled feature key.

Since:

2.10

Enum Constant Summary

ALL_USERS
Aka site wide feature, can be disabled during runtime.

ALL_USERS_READ_ONLY
Aka system feature, cannot be disabled during runtime.

CURRENT_USER_ONLY
The feature is enabled for the current user only.

Method Summary

static FeatureKeyScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static FeatureKeyScope[]	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_READ_ONLY

public static final FeatureKeyScope ALL_USERS_READ_ONLY

Aka system feature, cannot be disabled during runtime.

ALL_USERS

public static final FeatureKeyScope ALL_USERS

Aka site wide feature, can be disabled during runtime.

CURRENT_USER_ONLY

public static final FeatureKeyScope CURRENT_USER_ONLY

The feature is enabled for the current user only.

Method Detail

values

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

Returns:

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

valueOf

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