com.atlassian.confluence.internal.bigpipe

Class DefaultMacroSettings

java.lang.Object

com.atlassian.confluence.internal.bigpipe.DefaultMacroSettings

@Internal
public class DefaultMacroSettings
extends Object

This class is used for opting in/out macros from bigpipe. It is used to set-up setting on application startup, which avoids necessity of manual updating macro setting on every unicorn instance.

Since:

5.9

Constructor Summary

Constructors

Constructor and Description
DefaultMacroSettings(String pluginKey, String macroName)
DefaultMacroSettings(String pluginKey, String macroName, boolean optedIn)
DefaultMacroSettings(String pluginKey, String macroName, boolean optedIn, boolean force)

Method Summary

Modifier and Type	Method and Description
String	getMacroName()
String	getPluginKey()
boolean	isForce() By default existent settings are ignored.
boolean	isOptedIn()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMacroSettings

public DefaultMacroSettings(String pluginKey,
                            String macroName)

DefaultMacroSettings

public DefaultMacroSettings(String pluginKey,
                            String macroName,
                            boolean optedIn)

DefaultMacroSettings

public DefaultMacroSettings(String pluginKey,
                            String macroName,
                            boolean optedIn,
                            boolean force)

Parameters:

pluginKey - plugin key

macroName - macro name

optedIn - true if macro needs to be opted in or false otherwise

force - if true existent settings will be overwritten, false otherwise.

Method Detail

getPluginKey

public String getPluginKey()

Returns:

plugin key

getMacroName

public String getMacroName()

Returns:

macro name

isOptedIn

public boolean isOptedIn()

Returns:

true if macro is opted in, false otherwise

isForce

public boolean isForce()

By default existent settings are ignored. for example if admin opted in this macro manually, settings update on on startup won't make any effect. This default behaviur may be changed by setting force flag to true

Returns:

true if settings are forced to apply (will overwrite existent settings), false otherwise.