Package com.atlassian.confluence.macro

Class MacroExecutionContext

java.lang.Object

com.atlassian.confluence.macro.MacroExecutionContext

public class MacroExecutionContext
extends Object

Container for the execution context of a macro (i.e., the state passed to it on Macro.execute(java.util.Map, String, com.atlassian.renderer.RenderContext)).

Since:

2.9

Constructor Summary

Constructors

Constructor	Description
MacroExecutionContext(Map<String,String> params, String body, PageContext pageContext)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getBody()	Returns the body of the macro.
ContentEntityObject	getContent()	Returns the ContentEntityObject associated with this macro.
PageContext	getPageContext()	Returns the PageContext of the macro.
Map<String,String>	getParams()	Returns the macro parameters and their values.

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroExecutionContext

public MacroExecutionContext(Map<String,String> params,
                             String body,
                             PageContext pageContext)

Constructor.

Parameters:

params - the parameters passed to the macro from the page

body - the body of the macro (the text contained between the start and end tags)

pageContext - the PageContext that the macro is called from

Method Detail

getParams

public Map<String,String> getParams()

Returns the macro parameters and their values.

Returns:

the macro parameters and their values.

getBody

public String getBody()

Returns the body of the macro.

Returns:

the body of the macro

getPageContext

public PageContext getPageContext()

Returns the PageContext of the macro.

Returns:

the PageContext of the macro.

getContent

public ContentEntityObject getContent()

Returns the ContentEntityObject associated with this macro.

Returns:

the ContentEntityObject associated with this macro