com.atlassian.confluence.xhtml.api

Interface MacroDefinitionUpdater

public interface MacroDefinitionUpdater

Updater of MacroDefinitions in storage format. See XhtmlContent.updateMacroDefinitions(java.lang.String, com.atlassian.confluence.content.render.xhtml.ConversionContext, com.atlassian.confluence.xhtml.api.MacroDefinitionUpdater) for more detail.

Method Summary

Modifier and Type	Method and Description
MacroDefinition	update(MacroDefinition macroDefinition) Called each time a macro definition is found in the content so that each definition may be modified or replaced by another definition.

Method Detail

update

MacroDefinition update(MacroDefinition macroDefinition)

Called each time a macro definition is found in the content so that each definition may be modified or replaced by another definition.

Parameters:

macroDefinition - of the macro found in the content.

Returns:

a MacroDefinition to be placed in the resulting content, in place of the original definition and its body. Typically this will be the {code macroDefinition} parameter, which may have been modified. A null indicates that the macro should be removed.