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

Class StorageMacroV1Unmarshaller

java.lang.Object

com.atlassian.confluence.content.render.xhtml.storage.macro.StorageMacroV1Unmarshaller

All Implemented Interfaces:

Unmarshaller<MacroDefinition>

public class StorageMacroV1Unmarshaller
extends Object
implements Unmarshaller<MacroDefinition>

Parses XHTML containing ac:macro elements and their parameters. Handles the fact that some parameters (e.g. confluence-content) need additional parsing into structured types (e.g. Links containing ResourceIdentifiers) for the new intermediate format.

Constructor Summary

Constructors

Constructor and Description
StorageMacroV1Unmarshaller(XmlEventReaderFactory xmlEventReaderFactory, MacroParameterTypeParser macroParameterTypeParser, StorageMacroBodyParser storageMacroBodyParser)

Method Summary

Modifier and Type	Method and Description
boolean	handles(StartElement startElementEvent, ConversionContext conversionContext) Determines whether or not this unmarshaller should be applied to a fragment with the specified start element.
MacroDefinition	unmarshal(XMLEventReader reader, FragmentTransformer mainFragmentTransformer, ConversionContext conversionContext) Unmarshalls a StAX event stream to an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageMacroV1Unmarshaller

public StorageMacroV1Unmarshaller(XmlEventReaderFactory xmlEventReaderFactory,
                                  MacroParameterTypeParser macroParameterTypeParser,
                                  StorageMacroBodyParser storageMacroBodyParser)

Method Detail

handles

public boolean handles(StartElement startElementEvent,
                       ConversionContext conversionContext)

Description copied from interface: Unmarshaller

Determines whether or not this unmarshaller should be applied to a fragment with the specified start element.

Specified by:

handles in interface Unmarshaller<MacroDefinition>

Parameters:

startElementEvent - start element

conversionContext - the conversion context

Returns:

true if this unmarshaller can be applied, false otherwise

unmarshal

public MacroDefinition unmarshal(XMLEventReader reader,
                                 FragmentTransformer mainFragmentTransformer,
                                 ConversionContext conversionContext)
                          throws XhtmlException

Description copied from interface: Unmarshaller

Unmarshalls a StAX event stream to an object.

Specified by:

unmarshal in interface Unmarshaller<MacroDefinition>

Parameters:

reader - a reader over the fragment to unmarshall

mainFragmentTransformer - TODO

conversionContext - the conversion context

Returns:

the unmarshalled object

Throws:

XhtmlException - if some other problem occurs