com.atlassian.jira.config

Class FeatureFlag

java.lang.Object

com.atlassian.jira.config.FeatureFlag

All Implemented Interfaces:

Feature

public class FeatureFlag
extends Object
implements Feature

A FeatureFlag is a simple declaration of a key and whether the flag is considered on or off by default. The FeatureFlag is different from a Feature because it can have a default value. Additionally, feature flags can be declared via xml and shared across add-ons.

Since:

7.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	POSTFIX_DISABLED
static String	POSTFIX_ENABLED

Method Summary

Modifier and Type	Method and Description
FeatureFlag	defaultedTo(boolean defaultValue) Creates a new FeatureFlag that is defaulted to the specified value
String	disabledFeatureKey()
String	enabledFeatureKey()
boolean	equals(Object o)
static FeatureFlag	featureFlag(String featureKey) Creates a new FeatureFlag with the specified key and off by default
String	featureKey() The feature key that can be used to enable, disable or query the status of a feature using the FeatureManager.
int	hashCode()
boolean	isOnByDefault()
FeatureFlag	offByDefault() Creates a new FeatureFlag that is off by default
FeatureFlag	onByDefault() Creates a new FeatureFlag that is on by default
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

POSTFIX_ENABLED

public static final String POSTFIX_ENABLED

See Also:

Constant Field Values

POSTFIX_DISABLED

public static final String POSTFIX_DISABLED

See Also:

Constant Field Values

Method Detail

featureKey

public String featureKey()

Description copied from interface: Feature

The feature key that can be used to enable, disable or query the status of a feature using the FeatureManager.

Specified by:

featureKey in interface Feature

Returns:

the unique key used to identify the feature.

isOnByDefault

public boolean isOnByDefault()

Returns:

true if this feature is on by default

enabledFeatureKey

public String enabledFeatureKey()

Returns:

this feature key with the enabled postfix of POSTFIX_ENABLED

disabledFeatureKey

public String disabledFeatureKey()

Returns:

this feature key with the enabled postfix of POSTFIX_DISABLED

featureFlag

public static FeatureFlag featureFlag(String featureKey)

Creates a new FeatureFlag with the specified key and off by default

Parameters:

featureKey - the key in play

Returns:

a new feature flag

onByDefault

public FeatureFlag onByDefault()

Creates a new FeatureFlag that is on by default

Returns:

a new feature flag

offByDefault

public FeatureFlag offByDefault()

Creates a new FeatureFlag that is off by default

Returns:

a new feature flag

defaultedTo

public FeatureFlag defaultedTo(boolean defaultValue)

Creates a new FeatureFlag that is defaulted to the specified value

Returns:

a new feature flag

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object