public interface

MacroDefinitionReplacer

com.atlassian.confluence.xhtml.api.MacroDefinitionReplacer

Class Overview

Replacer of MacroDefinitions in storage format with other content. See replaceMacroDefinitionsWithString(String, ConversionContext, MacroDefinitionReplacer) for more detail.

Summary

Public Methods
String replace(MacroDefinition macroDefinition)
Called each time a macro definition is found in the content, so that each definition may be replaced different content.

Public Methods

public String replace (MacroDefinition macroDefinition)

Called each time a macro definition is found in the content, so that each definition may be replaced different content.

Parameters
macroDefinition of the macro found in the content.
Returns
  • a String to be placed in the resulting content, in place of the original definition and its body. A null indicates that the macro should be removed.
Throws
XhtmlException if there is a problem creating the modified fragment.