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

Class ViewMacroMarshaller

java.lang.Object

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

All Implemented Interfaces:

Marshaller<MacroDefinition>

public class ViewMacroMarshaller
extends Object
implements Marshaller<MacroDefinition>

Constructor Summary

Constructors

Constructor

Description

ViewMacroMarshaller(MacroManager macroManager, Marshaller<MacroDefinition> unknownMacroMarshaller, ViewMacroErrorPlaceholder viewMacroErrorPlaceholder, LegacyV2RendererContextInitialiser legacyV2RendererConfigurationPropertySetter, com.atlassian.event.api.EventPublisher eventPublisher, ConfluenceMonitoring monitoring, MacroAsyncRenderWhitelist macroAsyncRenderWhitelist, MacroMetadataManager macroMetadataManager, MacroSchemaMigrator macroSchemaMigrator, ViewMacroWrapper viewMacroWrapper, MacroRenderingMonitor macroRenderingMonitor)

Method Summary

Modifier and Type	Method	Description
static boolean	addMacroNameToExclusionSet(String macroName)	Adds provided macro name to the excluded macros set.
Streamable	marshal(MacroDefinition macroDefinition, ConversionContext conversionContext)	Marshals an object to XML.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewMacroMarshaller

public ViewMacroMarshaller(MacroManager macroManager,
 Marshaller<MacroDefinition> unknownMacroMarshaller,
 ViewMacroErrorPlaceholder viewMacroErrorPlaceholder,
 LegacyV2RendererContextInitialiser legacyV2RendererConfigurationPropertySetter,
 com.atlassian.event.api.EventPublisher eventPublisher,
 ConfluenceMonitoring monitoring,
 MacroAsyncRenderWhitelist macroAsyncRenderWhitelist,
 MacroMetadataManager macroMetadataManager,
 MacroSchemaMigrator macroSchemaMigrator,
 ViewMacroWrapper viewMacroWrapper,
 MacroRenderingMonitor macroRenderingMonitor)

Since:

5.9

Method Details

marshal

public Streamable marshal(MacroDefinition macroDefinition,
 ConversionContext conversionContext)
                   throws XhtmlException

Description copied from interface: Marshaller

Marshals an object to XML.

Specified by:

marshal in interface Marshaller<MacroDefinition>

Parameters:

macroDefinition - object to marshal

conversionContext - the conversion context

Returns:

the XML representation of the object

Throws:

XhtmlException - if an error occurs during marshalling

addMacroNameToExclusionSet

public static boolean addMacroNameToExclusionSet(String macroName)

Adds provided macro name to the excluded macros set. The macro names in this set are ones which are not treated as wrapped elements during the marshalling process.

Parameters:

macroName - the name of the macro to be added

Returns:

true if the macro name was successfully added to the exclusion set, false otherwise.

Since:

8.3.0