public interface

MacroManager

implements MacroManager
com.atlassian.confluence.renderer.MacroManager
Known Indirect Subclasses

Class Overview

Retrieval, registration and unregistration of macros.

Summary

Public Methods
abstract Map<String, Macro> getMacros()
Returns the currently enabled macros, excluding user macros.
abstract void registerMacro(String name, Macro macro)
Registers a new macro with the given name.
abstract void unregisterMacro(String name)
Unregisters the macro with the given name.
[Expand]
Inherited Methods
From interface com.atlassian.renderer.v2.macro.MacroManager

Public Methods

public abstract Map<String, Macro> getMacros ()

Returns the currently enabled macros, excluding user macros. For a list of user macros, see UserMacroLibrary.

public abstract void registerMacro (String name, 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

public abstract 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'.