com.atlassian.confluence.content.render.xhtml.editor.macro
Class EditorMacroUnmarshaller

java.lang.Object
  extended by com.atlassian.confluence.content.render.xhtml.editor.macro.EditorMacroUnmarshaller
All Implemented Interfaces:
Unmarshaller<MacroDefinition>

public class EditorMacroUnmarshaller
extends Object
implements Unmarshaller<MacroDefinition>

Transform the macro definition from the XHTML received from the editor into a holding object which can then be output into different formats such as storage format.

StorageMacroMarshaller is used to actually output the canonical storage form.


Constructor Summary
EditorMacroUnmarshaller(XMLOutputFactory xmlFragmentOutputFactory, XMLEventFactory xmlEventFactory, com.atlassian.confluence.content.render.xhtml.editor.macro.MacroNameAndParameterSubParser macroNameAndParameterSubParser, XmlEventReaderFactory xmlEventReaderFactory, XmlEntityExpander xmlEntityExpander)
           
 
Method Summary
 boolean handles(StartElement startElement, 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

EditorMacroUnmarshaller

public EditorMacroUnmarshaller(XMLOutputFactory xmlFragmentOutputFactory,
                               XMLEventFactory xmlEventFactory,
                               com.atlassian.confluence.content.render.xhtml.editor.macro.MacroNameAndParameterSubParser macroNameAndParameterSubParser,
                               XmlEventReaderFactory xmlEventReaderFactory,
                               XmlEntityExpander xmlEntityExpander)
Method Detail

handles

public boolean handles(StartElement startElement,
                       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:
startElement - 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


Copyright © 2003-2012 Atlassian. All Rights Reserved.