com.atlassian.confluence.macro

Interface Macro

All Known Subinterfaces:

StreamableMacro

All Known Implementing Classes:

ExpandMacro, GenericVelocityMacro, LazyLoadingMacroWrapper, LinkMacro, LoremIpsumMacro, MultimediaMacro, NaughtyWritingToDBWhilstRenderingMacro, ProcessedBodyMacro, StreamableMacroAdapter, UnmigratedBlockWikiMarkupMacro, UnmigratedInlineWikiMarkupMacro, UnprocessedBodyMacro, V2CompatibilityMacro

public interface Macro

Represents a Confluence macro.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Macro.BodyType
static class	Macro.OutputType

Method Summary

Methods

Modifier and Type	Method and Description
String	execute(Map<String,String> parameters, String body, ConversionContext context)
Macro.BodyType	getBodyType() The type of body that this macro has, this is used to infer the migration task if no custom one is provided.
Macro.OutputType	getOutputType()

Method Detail

execute

String execute(Map<String,String> parameters,
             String body,
             ConversionContext context)
               throws MacroExecutionException

Throws:

MacroExecutionException

getBodyType

Macro.BodyType getBodyType()

The type of body that this macro has, this is used to infer the migration task if no custom one is provided.

Returns:

The type of body this macro has.

getOutputType

Macro.OutputType getOutputType()