com.atlassian.sal.api.features

Class EnabledDarkFeatures

java.lang.Object

com.atlassian.sal.api.features.EnabledDarkFeatures

@Immutable
 @PublicApi
public final class EnabledDarkFeatures
extends Object

Represents a set of enabled features.

Since:

2.10

Field Summary

Fields

Modifier and Type	Field and Description
static EnabledDarkFeatures	NONE Shorthand in case there are no enabled dark features or they are disabled

Constructor Summary

Constructors

Constructor and Description
EnabledDarkFeatures(com.google.common.collect.ImmutableMap<FeatureKeyScope,com.google.common.collect.ImmutableSet<String>> enabledFeatures) Deprecated. since 4.6, use EnabledDarkFeatures(java.util.Map) instead.
EnabledDarkFeatures(Map<FeatureKeyScope,Set<String>> enabledFeatures) Create an instance of enabled features based on the given map.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<String>	getFeatureKeys() Deprecated. since 4.6, use getFeatureKeySet() instead
com.google.common.collect.ImmutableSet<String>	getFeatureKeys(com.google.common.base.Predicate<FeatureKeyScope> criteria) Deprecated. since 4.6, use getFeatureKeys(java.util.function.Predicate) instead.
Set<String>	getFeatureKeys(Predicate<FeatureKeyScope> criteria) Returns all enabled feature keys matching the given criteria.
Set<String>	getFeatureKeySet() Return all enabled feature keys, the set will be immutable.
boolean	isFeatureEnabled(String featureKey) Check that the given feature is enabled
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final EnabledDarkFeatures NONE

Shorthand in case there are no enabled dark features or they are disabled

Constructor Detail

EnabledDarkFeatures

@Deprecated
public EnabledDarkFeatures(com.google.common.collect.ImmutableMap<FeatureKeyScope,com.google.common.collect.ImmutableSet<String>> enabledFeatures)

Deprecated. since 4.6, use EnabledDarkFeatures(java.util.Map) instead.

Create an instance of enabled features based on the given map.

Parameters:

enabledFeatures - a map of enabled features

EnabledDarkFeatures

public EnabledDarkFeatures(Map<FeatureKeyScope,Set<String>> enabledFeatures)

Create an instance of enabled features based on the given map.

Parameters:

enabledFeatures - a map of enabled features

Since:

4.6.0

Method Detail

getFeatureKeys

@Deprecated
public com.google.common.collect.ImmutableSet<String> getFeatureKeys()

Deprecated. since 4.6, use getFeatureKeySet() instead

Return all enabled feature keys.

Returns:

all enabled feature keys

getFeatureKeySet

public Set<String> getFeatureKeySet()

Return all enabled feature keys, the set will be immutable.

Returns:

all enabled feature keys

Since:

4.6.0

getFeatureKeys

@Deprecated
public com.google.common.collect.ImmutableSet<String> getFeatureKeys(com.google.common.base.Predicate<FeatureKeyScope> criteria)

Deprecated. since 4.6, use getFeatureKeys(java.util.function.Predicate) instead.

Returns all enabled feature keys matching the given criteria.

Parameters:

criteria - the filter condition to be applied on the set of enabled features

Returns:

the filtered set of enabled features

getFeatureKeys

public Set<String> getFeatureKeys(Predicate<FeatureKeyScope> criteria)

Returns all enabled feature keys matching the given criteria. The set returned will be unmodifiable.

Parameters:

criteria - the filter condition to be applied on the set of enabled features

Returns:

the filtered set of enabled features

Since:

4.6.0

isFeatureEnabled

public boolean isFeatureEnabled(String featureKey)

Check that the given feature is enabled

Parameters:

featureKey - the feature key to be checked

Returns:

true if the given feature key is enabled, false otherwise

toString

public String toString()

Overrides:

toString in class Object