com.atlassian.confluence.content.render.xhtml.view.macro

Class DefaultViewMacroWrapper

java.lang.Object

com.atlassian.confluence.content.render.xhtml.view.macro.DefaultViewMacroWrapper

All Implemented Interfaces:

ViewMacroWrapper

@Internal
public class DefaultViewMacroWrapper
extends Object
implements ViewMacroWrapper

Since:

5.9

Constructor Summary

Constructors

Constructor and Description
DefaultViewMacroWrapper(XMLEventFactory xmlEventFactory, XmlEventReaderFactory xmlEventReaderFactory, XMLOutputFactory xmlOutputFactory, HtmlToXmlConverter htmlToXmlConverter, com.atlassian.plugin.event.PluginEventManager pluginEventManager)

Method Summary

Modifier and Type	Method and Description
void	destroy()
Streamable	executeWrapMacro(ConversionContext context, Macro macro, MarshallerMetricsCollector metricsCollector, MacroDefinition macroDefinition, Map<String,String> macroParameters) Execute macro wrapping.
void	init()
void	onPluginModuleDisable(com.atlassian.plugin.event.events.PluginModuleDisabledEvent ignored)
void	onPluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent ignored)
String	wrap(ConversionContext context, Macro.OutputType outputType, String macroBody, MacroDefinition macroDefinition, boolean wrap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultViewMacroWrapper

public DefaultViewMacroWrapper(XMLEventFactory xmlEventFactory,
                               XmlEventReaderFactory xmlEventReaderFactory,
                               XMLOutputFactory xmlOutputFactory,
                               HtmlToXmlConverter htmlToXmlConverter,
                               com.atlassian.plugin.event.PluginEventManager pluginEventManager)

Method Detail

init

@PostConstruct
public void init()

destroy

@PreDestroy
public void destroy()

onPluginModuleEnabled

public void onPluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent ignored)

onPluginModuleDisable

public void onPluginModuleDisable(com.atlassian.plugin.event.events.PluginModuleDisabledEvent ignored)

wrap

public String wrap(ConversionContext context,
                   Macro.OutputType outputType,
                   String macroBody,
                   MacroDefinition macroDefinition,
                   boolean wrap)

Specified by:

wrap in interface ViewMacroWrapper

executeWrapMacro

public Streamable executeWrapMacro(ConversionContext context,
                                   Macro macro,
                                   MarshallerMetricsCollector metricsCollector,
                                   MacroDefinition macroDefinition,
                                   Map<String,String> macroParameters)
                            throws MacroExecutionException

Description copied from interface: ViewMacroWrapper

Execute macro wrapping. Example: Status and

Info macro

Specified by:

executeWrapMacro in interface ViewMacroWrapper

Parameters:

context - the conversion context

macro - Confluence macro

metricsCollector - recording of execution and streaming as seperate phases. MetricsCollectingMarshaller

macroDefinition - definition of macro

macroParameters - macro parameter

Returns:

macro has wrapped otherwise the original

Throws:

MacroExecutionException - if an error occurs during executing