Interface ExceptionTolerantMigrator
-
- All Known Implementing Classes:
AbstractExceptionTolerantMigrator
,WikiToXhtmlMigrator
,XhtmlRoundTripMigrator
,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
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ExceptionTolerantMigrator.MigrationResult
Represents the results of an attempted migration.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method 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.
-
-
-
Method Detail
-
migrate
@Deprecated String migrate(String input, com.atlassian.renderer.RenderContext renderContext, List<RuntimeException> exceptions)
Deprecated.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 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)- 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.
-
migrate
ExceptionTolerantMigrator.MigrationResult migrate(String input, ConversionContext conversionContext)
Migrate the supplied content.- Parameters:
input
- the comtent to be migratedconversionContext
- the context to be applied for this migration- Returns:
- a
ExceptionTolerantMigrator.MigrationResult
containing the migrated content (if any), as well as indications of failures.
-
-