Package com.atlassian.confluence.macro.xhtml

Class UserMacroPluginMacroManager

java.lang.Object

com.atlassian.confluence.macro.xhtml.UserMacroPluginMacroManager

All Implemented Interfaces:

MacroManager

public class UserMacroPluginMacroManager
extends Object
implements MacroManager

A MacroManager responsible for keeping track of user macros loaded via the plugin subsystem. Listens for PluginModuleEnabledEvent and PluginModuleDisabledEvent to register GenericVelocityMacros with itself.

All macros will be wrapped in a LazyLoadingMacroWrapper.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
UserMacroPluginMacroManager(com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
Macro	getMacroByName(@NonNull String macroName)	Gives the Macro registered with the given name, or null if there is none registered with the manager.
io.atlassian.util.concurrent.LazyReference<Macro>	newLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)	Macros are lazy loaded to avoid plugin module ordering problems like CONF-13386.
void	pluginModuleDisabled(com.atlassian.plugin.event.events.PluginModuleDisabledEvent event)
void	pluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent event)
void	registerMacro(@NonNull String name, @NonNull Macro macro)	Registers a new macro with the given name.
void	setPluginEventManager(com.atlassian.plugin.event.PluginEventManager pluginEventManager)
void	unregisterMacro(@NonNull String name)	Unregisters the macro with the given name.

Methods inherited from class java.lang.Object

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

Constructor Details

UserMacroPluginMacroManager

public UserMacroPluginMacroManager(com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

getMacroByName

public Macro getMacroByName(@NonNull String macroName)

Description copied from interface: MacroManager

Gives the Macro registered with the given name, or null if there is none registered with the manager.

Specified by:

getMacroByName in interface MacroManager

Parameters:

macroName - The macro to get.

Returns:

The Macro, or null if there is none registered.

registerMacro

public void registerMacro(@NonNull String name,
 @NonNull Macro macro)

Description copied from interface: MacroManager

Registers a new macro with the given name. If a macro already exists with that name, it is replaced by the new macro.

Specified by:

registerMacro in interface MacroManager

Parameters:

name - the name to register the macro under. For example, 'code'.

macro - the macro to register

unregisterMacro

public void unregisterMacro(@NonNull String name)

Description copied from interface: MacroManager

Unregisters the macro with the given name. Does nothing if no such macro is registered.

Specified by:

unregisterMacro in interface MacroManager

Parameters:

name - the name of the macro to unregister. For example, 'code'.

pluginModuleEnabled

public void pluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent event)

pluginModuleDisabled

public void pluginModuleDisabled(com.atlassian.plugin.event.events.PluginModuleDisabledEvent event)

newLazyMacroReference

public io.atlassian.util.concurrent.LazyReference<Macro> newLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)

Description copied from interface: MacroManager

Macros are lazy loaded to avoid plugin module ordering problems like CONF-13386.

Specified by:

newLazyMacroReference in interface MacroManager

Parameters:

moduleDescriptor - describes the macro we are creating a lazy reference to.

Returns:

a LazyReference to a macro as described by the supplied ModuleDescriptor

setPluginEventManager

public void setPluginEventManager(com.atlassian.plugin.event.PluginEventManager pluginEventManager)