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

Class DefaultEditorFormatService

java.lang.Object

com.atlassian.confluence.content.render.xhtml.DefaultEditorFormatService

All Implemented Interfaces:

EditorFormatService

public class DefaultEditorFormatService
extends Object
implements EditorFormatService

Constructor Summary

Constructors

Constructor

Description

DefaultEditorFormatService(Marshaller<MacroDefinition> editorMacroMarshaller, Marshaller<Link> editorLinkMarshaller, Marshaller<EmbeddedImage> editorEmbeddedImageMarshaller, Unmarshaller<MacroDefinition> editorMacroUnmarshaller, Unmarshaller<Link> editorLinkUnmarshaller, Unmarshaller<EmbeddedImage> editorEmbeddedImageUnmarshaller, FragmentTransformer editorToStorageFragmentTransformer, FragmentTransformer storageToEditorFragmentTransformer, XmlEventReaderFactory xmlEventReaderFactory, ExceptionThrowingMigrator wikiToEditorHtmlMigrator)

Method Summary

Modifier and Type	Method	Description
EmbeddedImage	convertEditToEmbeddedImage(String editFragment, ConversionContext context)	Returns a EmbeddedImage from the supplied editFragment.
Link	convertEditToLink(String editFragment, ConversionContext context)	Returns a MacroDefinition from the supplied editFragment.
MacroDefinition	convertEditToMacroDefinition(String editFragment, ConversionContext context)	Returns a MacroDefinition from the supplied editFragment.
String	convertEditToStorage(String editFragment, ConversionContext context)	Returns an storage format fragment for the supplied editFragment.
String	convertEmbeddedImageToEdit(EmbeddedImage embeddedImage, ConversionContext context)	Returns an edit format fragment for the supplied embeddedImage.
String	convertLinkToEdit(Link link, ConversionContext context)	Returns an edit format fragment for the supplied link.
String	convertMacroDefinitionToEdit(MacroDefinition macroDefinition, ConversionContext context)	Returns an edit format fragment for the supplied macroDefinition.
String	convertStorageToEdit(String storageFragment, ConversionContext context)	Returns an edit format fragment for the supplied storageFragment.
String	convertWikiToEdit(String wikiContent, ConversionContext context)	Returns the XHTML edit format equivalent of the supplied wikiContent (Wiki markup).

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEditorFormatService

public DefaultEditorFormatService(Marshaller<MacroDefinition> editorMacroMarshaller,
                                  Marshaller<Link> editorLinkMarshaller,
                                  Marshaller<EmbeddedImage> editorEmbeddedImageMarshaller,
                                  Unmarshaller<MacroDefinition> editorMacroUnmarshaller,
                                  Unmarshaller<Link> editorLinkUnmarshaller,
                                  Unmarshaller<EmbeddedImage> editorEmbeddedImageUnmarshaller,
                                  FragmentTransformer editorToStorageFragmentTransformer,
                                  FragmentTransformer storageToEditorFragmentTransformer,
                                  XmlEventReaderFactory xmlEventReaderFactory,
                                  ExceptionThrowingMigrator wikiToEditorHtmlMigrator)

Method Detail

convertWikiToEdit

public String convertWikiToEdit(String wikiContent,
                                ConversionContext context)
                         throws XhtmlException

Description copied from interface: EditorFormatService

Returns the XHTML edit format equivalent of the supplied wikiContent (Wiki markup).

Specified by:

convertWikiToEdit in interface EditorFormatService

Parameters:

wikiContent - to be converted.

context - for the conversion.

Returns:

the XHTML storage format equivalent.

Throws:

XhtmlException - if there are any problems during the conversion.

convertStorageToEdit

public String convertStorageToEdit(String storageFragment,
                                   ConversionContext context)
                            throws XMLStreamException,
                                   XhtmlException

Description copied from interface: EditorFormatService

Returns an edit format fragment for the supplied storageFragment.

Specified by:

convertStorageToEdit in interface EditorFormatService

Parameters:

storageFragment - to be converted (for example the body of a macro).

context - for the conversion.

Returns:

the edit format fragment (HTML rather than XML).

Throws:

XMLStreamException - if there was a problem reading the storage fragment.

XhtmlException - if there was a problem creating the edit fragment.

convertEditToStorage

public String convertEditToStorage(String editFragment,
                                   ConversionContext context)
                            throws XMLStreamException,
                                   XhtmlException

Description copied from interface: EditorFormatService

Returns an storage format fragment for the supplied editFragment.

Specified by:

convertEditToStorage in interface EditorFormatService

Parameters:

editFragment - to be converted (for example the body of a macro).

context - for the conversion.

Returns:

the storage format fragment.

Throws:

XMLStreamException - if there was a problem reading the edit fragment.

XhtmlException - if there was a problem creating the storage fragment.

convertMacroDefinitionToEdit

public String convertMacroDefinitionToEdit(MacroDefinition macroDefinition,
                                           ConversionContext context)
                                    throws XhtmlException

Description copied from interface: EditorFormatService

Returns an edit format fragment for the supplied macroDefinition.

The body of the macro definition is expected to be in storage format. It will be transformed to editor format as part of the conversion carried out in this method.

Specified by:

convertMacroDefinitionToEdit in interface EditorFormatService

Parameters:

macroDefinition - that describes the macro. The body of this macro definition (returned by MacroDefinition.getBody() is expected to be in storage format.

context - for the conversion.

Returns:

the edit format fragment (HTML rather than XML).

Throws:

XhtmlException - if there was a problem creating the fragment.

convertLinkToEdit

public String convertLinkToEdit(Link link,
                                ConversionContext context)
                         throws XhtmlException

Description copied from interface: EditorFormatService

Returns an edit format fragment for the supplied link.

Specified by:

convertLinkToEdit in interface EditorFormatService

Parameters:

link - that describes the link.

context - for the conversion.

Returns:

the edit format fragment.

Throws:

XhtmlException - if there was a problem creating the fragment.

convertEmbeddedImageToEdit

public String convertEmbeddedImageToEdit(EmbeddedImage embeddedImage,
                                         ConversionContext context)
                                  throws XhtmlException

Description copied from interface: EditorFormatService

Returns an edit format fragment for the supplied embeddedImage.

Specified by:

convertEmbeddedImageToEdit in interface EditorFormatService

Parameters:

embeddedImage - that describes the resource (such as an image).

context - for the conversion.

Returns:

the edit format fragment.

Throws:

XhtmlException - if there was a problem creating the fragment.

convertEditToMacroDefinition

public MacroDefinition convertEditToMacroDefinition(String editFragment,
                                                    ConversionContext context)
                                             throws XMLStreamException,
                                                    XhtmlException

Description copied from interface: EditorFormatService

Returns a MacroDefinition from the supplied editFragment.

Specified by:

convertEditToMacroDefinition in interface EditorFormatService

Parameters:

editFragment - which should be the edit format definition of the macro (as XML rather than HTML).

context - for the conversion.

Returns:

the MacroDefinition.

Throws:

XMLStreamException - if there was a problem reading the edit fragment.

XhtmlException - if there was a problem creating the MacroDefinition.

convertEditToLink

public Link convertEditToLink(String editFragment,
                              ConversionContext context)
                       throws XMLStreamException,
                              XhtmlException

Description copied from interface: EditorFormatService

Returns a MacroDefinition from the supplied editFragment.

Specified by:

convertEditToLink in interface EditorFormatService

Parameters:

editFragment - which should be the edit format definition of the link (as XML rather than HTML).

context - for the conversion.

Returns:

the MacroDefinition.

Throws:

XMLStreamException - if there was a problem reading the edit fragment.

XhtmlException - if there was a problem creating the Link.

convertEditToEmbeddedImage

public EmbeddedImage convertEditToEmbeddedImage(String editFragment,
                                                ConversionContext context)
                                         throws XMLStreamException,
                                                XhtmlException

Description copied from interface: EditorFormatService

Returns a EmbeddedImage from the supplied editFragment.

Specified by:

convertEditToEmbeddedImage in interface EditorFormatService

Parameters:

editFragment - which should be the edit format definition of the embedded image (as XHTML rather than HTML).

context - for the conversion.

Returns:

the EmbeddedImage represented by the supplied editFragment.

Throws:

XMLStreamException - if there was a problem reading the edit fragment.

XhtmlException - if there was a problem creating the EmbeddedImage.