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.
Modifier and Type | Interface and Description |
---|---|
static class |
ExceptionTolerantMigrator.MigrationResult
Represents the results of an attempted migration.
|
Modifier and Type | Method and Description |
---|---|
ExceptionTolerantMigrator.MigrationResult |
migrate(String input,
ConversionContext conversionContext)
Migrate the supplied content.
|
String |
migrate(String input,
com.atlassian.renderer.RenderContext renderContext,
List<RuntimeException> exceptions)
Deprecated.
|
@Deprecated String migrate(String input, com.atlassian.renderer.RenderContext renderContext, List<RuntimeException> exceptions)
migrate(String, com.atlassian.confluence.content.render.xhtml.ConversionContext)
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.
input
- the String to be migratedrenderContext
- the context for the rendering during this migrationexceptions
- a List to add any migration exceptions too as they occur (this may be null if you don't care about exceptions)ExceptionTolerantMigrator.MigrationResult migrate(String input, ConversionContext conversionContext)
input
- the comtent to be migratedconversionContext
- the context to be applied for this migrationExceptionTolerantMigrator.MigrationResult
containing the migrated content (if any), as well as indications of failures.Copyright © 2003–2020 Atlassian. All rights reserved.