com.atlassian.confluence.content.render.xhtml

Interface Unmarshaller<T>

All Known Implementing Classes:

DelegatingResourceIdentifierUnmarshaller, DelegatingStorageMacroUnmarshaller, EditorAttachmentResourceIdentifierMarshallerAndUnmarshaller, EditorBlogPostResourceIdentifierMarshallerAndUnmarshaller, EditorEmbeddedImageResourceUnmarshaller, EditorEmoticonUnmarshaller, EditorIdAndTypeResourceIdentifierUnmarshaller, EditorInlineCommentMarkerUnmarshaller, EditorLinkBodyUnmarshaller, EditorLinkUnmarshaller, EditorMacroUnmarshaller, EditorPageLayoutUnMarshaller, EditorPageResourceIdentifierMarshallerAndUnmarshaller, EditorPlaceholderUnmarshaller, EditorShortcutResourceIdentifierMarshallerAndUnmarshaller, EditorSpaceResourceIdentifierMarshallerAndUnmarshaller, EditorTimeUnmarshaller, EditorUserResourceIdentifierMarshallerAndUnmarshaller, IdAndTypeAnalyzingResourceIdentifierUnmarshaller, ImageLinkEmoticonUnmarshaller, StorageEmbeddedImageUnmarshaller, StorageEmoticonUnmarshaller, StorageInlineCommentMarkerUnmarshaller, StorageInlineTaskUnmarshaller, StorageLegacyPageLayoutUnMarshaller, StorageLinkUnmarshaller, StorageMacroV1Unmarshaller, StorageMacroV2Unmarshaller, StoragePageLayoutUnMarshaller, StoragePlaceholderUnmarshaller, StoragePlainTextLinkBodyUnmarshaller, StorageResourceIdentifierUnmarshaller, StorageRichTextLinkBodyUnmarshaller, StorageTimeUnmarshaller, StorageUserResourceIdentifierUnmarshaller, ViewInlineTaskUnmarshaller

public interface Unmarshaller<T>

Responsible for unmarshalling an XML fragment.

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.
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