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

All Known Implementing Classes:

WikiToEditorHtmlMigrator

public interface ExceptionThrowingMigrator

Migrates / converts text from one format to another.

This interface differs from ExceptionTolerantMigrator in that it can only cope with a single Exception from the migration process, which it will throw, stopping the migration.

Since:

4.0

Method Summary

java.lang.String

migrate(java.lang.String input, com.atlassian.renderer.RenderContext renderContext) Migrate the supplied text to a different text format.

Method Detail

migrate

java.lang.String migrate(java.lang.String input,
                         com.atlassian.renderer.RenderContext renderContext)
                         throws XhtmlException

Migrate the supplied text to a different text format.

Parameters:

input - the String to be migrated

renderContext - the context for the rendering during this migration

Returns:

the converted version of the supplied input text.

Throws:

XhtmlException - should there be problems migrating the supplied input.