com.atlassian.confluence.renderer
Class UserMacroLibrary
java.lang.Object
com.atlassian.confluence.renderer.UserMacroLibrary
- All Implemented Interfaces:
- org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean
public class UserMacroLibrary
- extends Object
- implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean
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.
Constructor Summary |
UserMacroLibrary(com.atlassian.bandana.BandanaManager bandanaManager,
com.atlassian.event.api.EventListenerRegistrar eventListenerRegistrar,
TenantRegistry tenantRegistry)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
LIBRARY_KEY
public static final String LIBRARY_KEY
- See Also:
- Constant Field Values
UserMacroLibrary
public UserMacroLibrary(com.atlassian.bandana.BandanaManager bandanaManager,
com.atlassian.event.api.EventListenerRegistrar eventListenerRegistrar,
TenantRegistry tenantRegistry)
addUpdateMacro
public void addUpdateMacro(UserMacroConfig userMacroConfig)
hasMacro
public boolean hasMacro(String name)
getMacro
public UserMacroConfig getMacro(String name)
removeMacro
public void removeMacro(String name)
getMacroNames
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.
getMacros
public Map<String,UserMacroConfig> getMacros()
- Returns:
- all the user macros except for those that are hidden by a duplicate macro from a plugin.
pluginMacroRegistered
@EventListener
public void pluginMacroRegistered(PluginMacroRegisteredEvent event)
pluginMacroUnregistered
@EventListener
public void pluginMacroUnregistered(PluginMacroUnregisteredEvent event)
destroy
public void destroy()
throws Exception
- Specified by:
destroy
in interface org.springframework.beans.factory.DisposableBean
- Throws:
Exception
afterPropertiesSet
public void afterPropertiesSet()
throws Exception
- Specified by:
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
- Throws:
Exception
Copyright © 2003–2015 Atlassian. All rights reserved.