Package com.atlassian.confluence.setup.settings

Class DarkFeatures

java.lang.Object

com.atlassian.confluence.setup.settings.DarkFeatures

public class DarkFeatures
extends Object

Represents the current state of the dark features for a particular user.

Constructor Summary

Constructors

Constructor	Description
DarkFeatures(Set<String> systemEnabledFeatures, Set<String> siteEnabledFeatures)
DarkFeatures(Set<String> systemEnabledFeatures, Set<String> siteEnabledFeatures, Set<String> userEnabledFeatures)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAllEnabledFeatures()
String	getAllEnabledFeaturesAsString()	Return all the enabled features, joined with commas.
Set<String>	getGlobalEnabledFeatures()	Returns Dark Features enabled for all users, whether by system.property or site configuration.
Set<String>	getSiteEnabledFeatures()
Set<String>	getSystemEnabledFeatures()
static boolean	isDarkFeatureEnabled(ConfluenceUser user, String featureKey)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3.
static boolean	isDarkFeatureEnabled(com.atlassian.user.User user, String featureKey)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
static boolean	isDarkFeatureEnabled(String featureKey)	Returns true if the dark feature is enabled for the current user, either because of a user preference or because it is enabled site-wide via a site or system setting.
boolean	isFeatureEnabled(String featureKey)

Methods inherited from class java.lang.Object

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

Constructor Details

DarkFeatures

@Deprecated(since="9.3",
            forRemoval=true)
public DarkFeatures(Set<String> systemEnabledFeatures,
 Set<String> siteEnabledFeatures,
 Set<String> userEnabledFeatures)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3. userEnabledFeatures are no longer supported. Use DarkFeatures(Set, Set) instead.

DarkFeatures

public DarkFeatures(Set<String> systemEnabledFeatures,
 Set<String> siteEnabledFeatures)

Method Details

getSystemEnabledFeatures

public Set<String> getSystemEnabledFeatures()

getSiteEnabledFeatures

public Set<String> getSiteEnabledFeatures()

getGlobalEnabledFeatures

public Set<String> getGlobalEnabledFeatures()

Returns Dark Features enabled for all users, whether by system.property or site configuration.

getAllEnabledFeatures

public Set<String> getAllEnabledFeatures()

getAllEnabledFeaturesAsString

public String getAllEnabledFeaturesAsString()

Return all the enabled features, joined with commas.

isFeatureEnabled

public boolean isFeatureEnabled(String featureKey)

isDarkFeatureEnabled

public static boolean isDarkFeatureEnabled(String featureKey)

Returns true if the dark feature is enabled for the current user, either because of a user preference or because it is enabled site-wide via a site or system setting.

isDarkFeatureEnabled

@Deprecated(since="9.3",
            forRemoval=true)
public static boolean isDarkFeatureEnabled(ConfluenceUser user,
 String featureKey)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3. Use isDarkFeatureEnabled(String) instead.

Returns true if the dark feature is enabled for the given user, either because of a user preference or because it is enabled site-wide via a site or system setting.

Since:

5.2

isDarkFeatureEnabled

@Deprecated(since="5.2",
            forRemoval=true)
public static boolean isDarkFeatureEnabled(com.atlassian.user.User user,
 String featureKey)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 5.2. Use isDarkFeatureEnabled(String) instead.