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

Class DefaultFormatConverter

java.lang.Object

com.atlassian.confluence.content.render.xhtml.DefaultFormatConverter

All Implemented Interfaces:

FormatConverter

public class DefaultFormatConverter
extends Object
implements FormatConverter

Field Summary

Fields

Modifier and Type	Field	Description
protected EditorConverter	editConverter
protected Renderer	editRenderer
protected RenderingEventPublisher	renderingEventPublisher
protected StorageFormatCleaner	storageFormatCleaner
protected Renderer	viewRenderer

Constructor Summary

Constructors

Constructor	Description
DefaultFormatConverter(EditorConverter editConverter, Renderer editRenderer, Renderer viewRenderer, StorageFormatCleaner storageFormatCleaner)	Deprecated. since 5.6 use DefaultFormatConverter(com.atlassian.confluence.content.render.xhtml.editor.EditorConverter, Renderer, Renderer, StorageFormatCleaner, RenderingEventPublisher)
DefaultFormatConverter(EditorConverter editConverter, Renderer editRenderer, Renderer viewRenderer, StorageFormatCleaner storageFormatCleaner, RenderingEventPublisher renderingEventPublisher)

Method Summary

Modifier and Type	Method	Description
String	cleanEditorFormat(String wysiwygContent, com.atlassian.renderer.RenderContext renderContext)	Cleans the editor format
String	convertToEditorFormat(String storageFormat, com.atlassian.renderer.RenderContext renderContext)	Converts the storage format into the editor format.
RenderResult	convertToEditorFormatWithResult(String storageFormat, com.atlassian.renderer.RenderContext renderContext)	Converts the storage format into the editor format.
String	convertToStorageFormat(String wysiwygContent, com.atlassian.renderer.RenderContext renderContext)	Returns the content that has been submitted as part of a user's attempt to add new content or edit existing content.
String	convertToViewFormat(String storageFormat, com.atlassian.renderer.RenderContext renderContext)	Converts the storage format into the view format.
String	validateAndConvertToStorageFormat(ConfluenceActionSupport action, String wysiwygContent, com.atlassian.renderer.RenderContext renderContext)	Validates, and adds any errors to the action.
String	validateAndConvertToStorageFormat(String wysiwygContent, com.atlassian.renderer.RenderContext renderContext)	Validates, throwing exceptions if failures found.

Methods inherited from class java.lang.Object

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

Field Detail

editConverter

protected EditorConverter editConverter

editRenderer

protected Renderer editRenderer

viewRenderer

protected Renderer viewRenderer

storageFormatCleaner

protected StorageFormatCleaner storageFormatCleaner

renderingEventPublisher

protected RenderingEventPublisher renderingEventPublisher

Constructor Detail

DefaultFormatConverter

@Deprecated
public DefaultFormatConverter(EditorConverter editConverter,
                              Renderer editRenderer,
                              Renderer viewRenderer,
                              StorageFormatCleaner storageFormatCleaner)

Deprecated.

since 5.6 use DefaultFormatConverter(com.atlassian.confluence.content.render.xhtml.editor.EditorConverter, Renderer, Renderer, StorageFormatCleaner, RenderingEventPublisher)

DefaultFormatConverter

public DefaultFormatConverter(EditorConverter editConverter,
                              Renderer editRenderer,
                              Renderer viewRenderer,
                              StorageFormatCleaner storageFormatCleaner,
                              RenderingEventPublisher renderingEventPublisher)

Method Detail

validateAndConvertToStorageFormat

public String validateAndConvertToStorageFormat(ConfluenceActionSupport action,
                                                String wysiwygContent,
                                                com.atlassian.renderer.RenderContext renderContext)

Description copied from interface: FormatConverter

Validates, and adds any errors to the action. Returns the storage format if successful.

Specified by:

validateAndConvertToStorageFormat in interface FormatConverter

Parameters:

action - action to add any errors found into

Returns:

validateAndConvertToStorageFormat

public String validateAndConvertToStorageFormat(String wysiwygContent,
                                                com.atlassian.renderer.RenderContext renderContext)
                                         throws BadRequestException

Description copied from interface: FormatConverter

Validates, throwing exceptions if failures found. Returns the storage format if successful.

Specified by:

validateAndConvertToStorageFormat in interface FormatConverter

Returns:

Throws:

BadRequestException

convertToStorageFormat

public String convertToStorageFormat(String wysiwygContent,
                                     com.atlassian.renderer.RenderContext renderContext)
                              throws XhtmlException

Description copied from interface: FormatConverter

Returns the content that has been submitted as part of a user's attempt to add new content or edit existing content. The content is returned in storage format ready for saving.

Specified by:

convertToStorageFormat in interface FormatConverter

Returns:

the content that has been submitted as part of a user's attempt to add new content or edit existing content.

Throws:

XhtmlParsingException

XhtmlException

convertToEditorFormat

public String convertToEditorFormat(String storageFormat,
                                    com.atlassian.renderer.RenderContext renderContext)

Description copied from interface: FormatConverter

Converts the storage format into the editor format.

Specified by:

convertToEditorFormat in interface FormatConverter

Returns:

convertToEditorFormatWithResult

public RenderResult convertToEditorFormatWithResult(String storageFormat,
                                                    com.atlassian.renderer.RenderContext renderContext)

Description copied from interface: FormatConverter

Converts the storage format into the editor format.

Specified by:

convertToEditorFormatWithResult in interface FormatConverter

Returns:

convertToViewFormat

public String convertToViewFormat(String storageFormat,
                                  com.atlassian.renderer.RenderContext renderContext)

Description copied from interface: FormatConverter

Converts the storage format into the view format.

Specified by:

convertToViewFormat in interface FormatConverter

Returns:

cleanEditorFormat

public String cleanEditorFormat(String wysiwygContent,
                                com.atlassian.renderer.RenderContext renderContext)
                         throws XhtmlException

Description copied from interface: FormatConverter

Cleans the editor format

Specified by:

cleanEditorFormat in interface FormatConverter

Returns:

a cleaned version of the editorFormat

Throws:

XhtmlException