Package com.atlassian.confluence.macro.xhtml

Interface MacroManager

    • Method Detail

      • getMacroByName

        Macro getMacroByName​(String macroName)
        Gives the Macro registered with the given name, or null if there is none registered with the manager.
        Parameters:
        macroName - The macro to get.
        Returns:
        The Macro, or null if there is none registered.

      • registerMacro

        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

      • 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'.

      • createLazyMacroReference

        @Deprecated
com.atlassian.util.concurrent.LazyReference<Macro> createLazyMacroReference​(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
        Deprecated.
        since 7.0.1. Use newLazyMacroReference(ModuleDescriptor)
        Macros are lazy loaded to avoid plugin module ordering problems like CONF-13386.
        Parameters:
        moduleDescriptor - describes the macro we are creating a lazy reference to.
        Returns:
        a LazyReference to a macro as described by the supplied ModuleDescriptor

      • newLazyMacroReference

        default io.atlassian.util.concurrent.LazyReference<Macro> newLazyMacroReference​(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
        Macros are lazy loaded to avoid plugin module ordering problems like CONF-13386.
        Parameters:
        moduleDescriptor - describes the macro we are creating a lazy reference to.
        Returns:
        a LazyReference to a macro as described by the supplied ModuleDescriptor
        Since:
        7.0.1