Package com.atlassian.confluence.impl.macro.schema

Class DefaultMacroSchemaMigrator

java.lang.Object

com.atlassian.confluence.impl.macro.schema.DefaultMacroSchemaMigrator

All Implemented Interfaces:

MacroSchemaMigrator

public class DefaultMacroSchemaMigrator
extends Object
implements MacroSchemaMigrator

Constructor Summary

Constructors

Constructor	Description
DefaultMacroSchemaMigrator(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method	Description
MacroDefinition	migrateSchemaIfNecessary(MacroDefinition macroDefinition, ConversionContext context)	Migrates the macro definition to the latest version of it's macro schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMacroSchemaMigrator

public DefaultMacroSchemaMigrator(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

migrateSchemaIfNecessary

public MacroDefinition migrateSchemaIfNecessary(MacroDefinition macroDefinition,
                                                ConversionContext context)
                                         throws XhtmlException

Description copied from interface: MacroSchemaMigrator

Migrates the macro definition to the latest version of it's macro schema.

Specified by:

migrateSchemaIfNecessary in interface MacroSchemaMigrator

Parameters:

macroDefinition - the macro definition to migrate

context - the context used to perform the migration

Returns:

the migrated macro definition or the existing macro definition if no migration occured

Throws:

XhtmlException - if any migrations fail