public class UserMacroLibraryMacroManager extends Object implements MacroManager
An Xhtml MacroManager implementation that delegates to an encapsulated UserMacroLibrary. Therefore this MacroManager is aware of UI created User Macros only. User macros via plugins are a different proposition.
This manager is a read only facade onto the UserMacroLibrary and therefore any attempts to call
registerMacro(String, Macro)
or unregisterMacro(String)
will result in an
UnsupportedOperationException being thrown.
UserMacroLibrary
Constructor and Description |
---|
UserMacroLibraryMacroManager(UserMacroLibrary userMacroLibrary) |
Modifier and Type | Method and Description |
---|---|
com.atlassian.util.concurrent.LazyReference<Macro> |
createLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
Deprecated.
since 7.0.1. Use
MacroManager.newLazyMacroReference(ModuleDescriptor) |
Macro |
getMacroByName(String macroName)
Gives the
Macro registered with the
given name, or null if there is none registered with the manager. |
void |
registerMacro(String name,
Macro macro)
Registers a new macro with the given name.
|
void |
unregisterMacro(String name)
Unregisters the macro with the given name.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
newLazyMacroReference
public UserMacroLibraryMacroManager(UserMacroLibrary userMacroLibrary)
public Macro getMacroByName(String macroName)
MacroManager
Macro
registered with the
given name, or null if there is none registered with the manager.getMacroByName
in interface MacroManager
macroName
- The macro to get.public void registerMacro(String name, Macro macro)
MacroManager
registerMacro
in interface MacroManager
name
- the name to register the macro under. For example, 'code'.macro
- the macro to registerUnsupportedOperationException
public void unregisterMacro(String name)
MacroManager
unregisterMacro
in interface MacroManager
name
- the name of the macro to unregister. For example, 'code'.UnsupportedOperationException
@Deprecated public com.atlassian.util.concurrent.LazyReference<Macro> createLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
MacroManager.newLazyMacroReference(ModuleDescriptor)
MacroManager
createLazyMacroReference
in interface MacroManager
moduleDescriptor
- describes the macro we are creating a lazy reference to.UnsupportedOperationException
Copyright © 2003–2019 Atlassian. All rights reserved.