com.atlassian.bitbucket.server

Interface FeatureManager

public interface FeatureManager

Provides access to bitbucket.properties flags for enabling/disabling various features.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
boolean	isAvailable(Feature feature)
boolean	isEnabled(Feature feature)
boolean	isEnabled(Feature feature, boolean defaultValue)
void	requireEnabled(Feature feature) Ensures that Feature is available and enabled.
void	requireEnabled(Feature feature, boolean defaultValue) Ensures that Feature is available and enabled.

Method Detail

isAvailable

boolean isAvailable(@Nonnull
                    Feature feature)

Parameters:

feature - the feature to check

Returns:

true if the feature is available for the current license type; otherwise false

isEnabled

boolean isEnabled(@Nonnull
                  Feature feature)

Parameters:

feature - the feature to check

Returns:

true if the feature is available and enabled; otherwise, false

isEnabled

boolean isEnabled(@Nonnull
                  Feature feature,
                  boolean defaultValue)

Parameters:

feature - the feature to check

defaultValue - the value to return if no property has been defined for the feature

Returns:

true if the feature is available and enabled, false if the feature is not available or disabled; otherwise defaultValue

requireEnabled

void requireEnabled(@Nonnull
                    Feature feature)

Ensures that Feature is available and enabled. If there is no property for the Feature, assumes it is disabled.

Parameters:

feature - the Feature to check

Throws:

FeatureUnavailableException - in case if Feature is unavailable

FeatureDisabledException - in case if Feature is disabled

Since:

6.5

requireEnabled

void requireEnabled(@Nonnull
                    Feature feature,
                    boolean defaultValue)

Ensures that Feature is available and enabled. If there is no property for the Feature, uses supplied default value as enabled/disabled state of the Feature

Parameters:

feature - the Feature to check

defaultValue - assume feature enabled/disabled by default

Throws:

FeatureUnavailableException - in case if Feature is unavailable

FeatureDisabledException - in case if Feature is disabled

Since:

6.5