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

All Known Implementing Classes:
WikiToXhtmlMigrator, XhtmlWikiMarkupMacroMigrator

public interface ExceptionTolerantMigrator

Migrates / converts text from one text format to another.

Implementations should be tolerant to Exceptions that occur during the migration and still return suitably migrated content with the exceptions populated in the supplied List.

Since:
4.0

Method Summary
 String migrate(String input, com.atlassian.renderer.RenderContext renderContext, List<RuntimeException> exceptions)
           Migrate the supplied text to a different text format.
 

Method Detail

migrate

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

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.

Parameters:
input - 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.


Copyright © 2003-2011 Atlassian. All Rights Reserved.