public class

UserMacroLibrary

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.renderer.UserMacroLibrary

Class Overview

A library of user defined macros, stored in and retrieved from Bandana on request.

Note that since Confluence 4.0 this UserMacroLibrary is now aware of when user macros have been hidden by an identically named macro from a plugin (even a user macro from a plugin). So the existing methods on the library will now only return macros that are not hidden.

Summary

Constants
String LIBRARY_KEY
Public Constructors
UserMacroLibrary(BandanaManager bandanaManager, EventPublisher eventPublisher)
Public Methods
void addUpdateMacro(UserMacroConfig userMacroConfig)
UserMacroConfig getMacro(String name)
SortedSet<String> getMacroNames()
Map<String, UserMacroConfig> getMacros()
boolean hasMacro(String name)
@EventListener void pluginMacroRegistered(PluginMacroRegisteredEvent event)
@EventListener void pluginMacroUnregistered(PluginMacroUnregisteredEvent event)
void removeMacro(String name)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String LIBRARY_KEY

Constant Value: "confluence.user"

Public Constructors

public UserMacroLibrary (BandanaManager bandanaManager, EventPublisher eventPublisher)

Public Methods

public void addUpdateMacro (UserMacroConfig userMacroConfig)

public UserMacroConfig getMacro (String name)

public SortedSet<String> getMacroNames ()

Returns
  • the names of all the user macros except for those that are hidden by a duplicate macro from a plugin.

public Map<String, UserMacroConfig> getMacros ()

Returns
  • all the user macros except for those that are hidden by a duplicate macro from a plugin.

public boolean hasMacro (String name)

@EventListener public void pluginMacroRegistered (PluginMacroRegisteredEvent event)

@EventListener public void pluginMacroUnregistered (PluginMacroUnregisteredEvent event)

public void removeMacro (String name)