com.atlassian.confluence.xhtml.api

Interface WikiToStorageConverter

All Known Subinterfaces:

XhtmlContent

All Known Implementing Classes:

DefaultXhtmlContent, WikiToStorageConverterImpl

public interface WikiToStorageConverter

Defines operations for converting wiki format to storage format.

Since:

7.6

Method Summary

Modifier and Type	Method and Description
<T extends ContentEntityObject> T	convertWikiBodyToStorage(T ceo) Convert the body of the supplied ContentEntityObject to Confluence Storage Format XHTML (if necessary).
String	convertWikiToStorage(String wikiContent, ConversionContext context, List<RuntimeException> migrationExceptions) Returns the XHTML storage format equivalent of the supplied wikiContent (wiki markup).

Method Detail

convertWikiToStorage

String convertWikiToStorage(String wikiContent,
                            ConversionContext context,
                            List<RuntimeException> migrationExceptions)

Returns the XHTML storage format equivalent of the supplied wikiContent (wiki markup).

Parameters:

wikiContent - to be converted.

context - for the conversion.

migrationExceptions - that will be populated with any exceptions that take place during the migration. There may be multiple exceptions if there are multiple wiki markup sections.

Returns:

the XHTML storage format equivalent.

convertWikiBodyToStorage

<T extends ContentEntityObject> T convertWikiBodyToStorage(T ceo)

Convert the body of the supplied ContentEntityObject to Confluence Storage Format XHTML (if necessary).

Since for now and the near future Confluence may have both wiki formatted and XHTML formatted ContentEntityObjects in the system (wiki formatted historical versions may be present in an upgraded installation) this method provides a convenient way to ensure you only need to handle ContentEntityObjects with the new XHTML format of body.

Note that the returned ceo is a clone of the passed in version, even if no conversion was necessary.

Parameters:

ceo - the ContentEntityObject to be converted (if necessary).

Returns:

a clone of the provided ContentEntityObject with its wiki formatted body converted.