com.atlassian.confluence.content.render.xhtml
Interface Unmarshaller<T>

All Known Implementing Classes:

DelegatingResourceIdentifierUnmarshaller, EditorAttachmentResourceIdentifierMarshallerAndUnmarshaller, EditorBlogPostResourceIdentifierMarshallerAndUnmarshaller, EditorCaretUnmarshaller, EditorEmbeddedImageResourceUnmarshaller, EditorEmoticonUnmarshaller, EditorIdAndTypeResourceIdentifierUnmarshaller, EditorLinkBodyUnmarshaller, EditorLinkUnmarshaller, EditorMacroUnmarshaller, EditorPageResourceIdentifierMarshallerAndUnmarshaller, EditorPlaceholderUnmarshaller, EditorShortcutResourceIdentifierMarshallerAndUnmarshaller, EditorSpaceResourceIdentifierMarshallerAndUnmarshaller, EditorUserResourceIdentifierMarshallerAndUnmarshaller, IdAndTypeAnalyzingResourceIdentifierUnmarshaller, StorageCaretUnmarshaller, StorageEmbeddedImageUnmarshaller, StorageEmoticonUnmarshaller, StorageInlineTaskUnmarshaller, StorageLinkUnmarshaller, StorageMacroUnmarshaller, StoragePlaceholderUnmarshaller, StoragePlainTextLinkBodyUnmarshaller, StorageResourceIdentifierUnmarshaller, StorageRichTextLinkBodyUnmarshaller, ViewInlineTaskUnmarshaller

public interface Unmarshaller<T>

Responsible for unmarshalling an XML fragment.

Method Summary

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

Method Detail

unmarshal

T unmarshal(XMLEventReader xmlEventReader,
            FragmentTransformer mainFragmentTransformer,
            ConversionContext conversionContext)
            throws XhtmlException

Unmarshalls a StAX event stream to an object.

Parameters:

xmlEventReader - a reader over the fragment to unmarshall

mainFragmentTransformer - TODO

conversionContext - the conversion context

Returns:

the unmarshalled object

Throws:

UnmarshalException - if an error occurs during unmarshalling

XhtmlException - if some other problem occurs

handles

boolean handles(StartElement startElementEvent,
                ConversionContext conversionContext)

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

Parameters:

startElementEvent - start element

conversionContext - the conversion context

Returns:

true if this unmarshaller can be applied, false otherwise