Interface MacroManager
-
- All Superinterfaces:
com.atlassian.renderer.v2.macro.MacroManager
- All Known Implementing Classes:
DefaultMacroManager
public interface MacroManager extends com.atlassian.renderer.v2.macro.MacroManager
Retrieval, registration and unregistration of macros.- Since:
- 3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,com.atlassian.renderer.v2.macro.Macro>
getMacros()
Returns the currently enabled macros, excluding user macros.void
registerMacro(String name, com.atlassian.renderer.v2.macro.Macro macro)
Registers a new macro with the given name.void
unregisterMacro(String name)
Unregisters the macro with the given name.
-
-
-
Method Detail
-
getMacros
Map<String,com.atlassian.renderer.v2.macro.Macro> getMacros()
Returns the currently enabled macros, excluding user macros. For a list of user macros, seeUserMacroLibrary
.
-
registerMacro
void registerMacro(String name, com.atlassian.renderer.v2.macro.Macro macro)
Registers a new macro with the given name. If a macro already exists with that name, it is replaced by the new macro.- Parameters:
name
- the name to register the macro under. For example, 'code'.macro
- the macro to register
-
unregisterMacro
void unregisterMacro(String name)
Unregisters the macro with the given name. Does nothing if no such macro is registered.- Parameters:
name
- the name of the macro to unregister. For example, 'code'.
-
-