com.atlassian.confluence.content.render.xhtml.migration

Class AbstractExceptionTolerantMigrator

java.lang.Object

com.atlassian.confluence.content.render.xhtml.migration.AbstractExceptionTolerantMigrator

All Implemented Interfaces:

ExceptionTolerantMigrator

Direct Known Subclasses:

XhtmlRoundTripMigrator, XhtmlWikiMarkupMacroMigrator

public abstract class AbstractExceptionTolerantMigrator
extends Object
implements ExceptionTolerantMigrator

A partial implementation of ExceptionTolerantMigrator which provides a default implementation of the deprecated migrate(String, com.atlassian.renderer.RenderContext, java.util.List) method, which delegates to the ExceptionTolerantMigrator.migrate(String, com.atlassian.confluence.content.render.xhtml.ConversionContext) method.

Since:

5.3

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.content.render.xhtml.migration.ExceptionTolerantMigrator

ExceptionTolerantMigrator.MigrationResult

Constructor Summary

Constructors

Constructor and Description
AbstractExceptionTolerantMigrator()

Method Summary

Modifier and Type	Method and Description
String	migrate(String content, com.atlassian.renderer.RenderContext renderContext, List<RuntimeException> exceptions) Migrate the supplied text to a different text format.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.content.render.xhtml.migration.ExceptionTolerantMigrator

migrate

Constructor Detail

AbstractExceptionTolerantMigrator

public AbstractExceptionTolerantMigrator()

Method Detail

migrate

public String migrate(String content,
                      com.atlassian.renderer.RenderContext renderContext,
                      List<RuntimeException> exceptions)

Description copied from interface: ExceptionTolerantMigrator

Migrate the supplied text to a different text format.

It should be noted that if the exceptions parameter is populated during execution then you cannot necessarily guarantee that the returned content is of a format you expect to deal with. You must check the implementation of this interface for details on the exception behaviour with respect to the return value.

Specified by:

migrate in interface ExceptionTolerantMigrator

Parameters:

content - the String to be migrated

renderContext - the context for the rendering during this migration

exceptions - a List to add any migration exceptions too as they occur (this may be null if you don't care about exceptions)

Returns:

the converted version of the supplied input text in the case of no exceptions reported (in the exceptions parameters list). Should exceptions have occurred then you must consult the implementation to learn what will be returned.