org.randombits.support.confluence

Class ConfluenceMacro

java.lang.Object

org.randombits.support.confluence.ConfluenceMacro

All Implemented Interfaces:

com.atlassian.confluence.macro.Macro

public abstract class ConfluenceMacro
extends java.lang.Object
implements com.atlassian.confluence.macro.Macro

Author:

David Peterson

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.macro.Macro

com.atlassian.confluence.macro.Macro.BodyType, com.atlassian.confluence.macro.Macro.OutputType

Constructor Summary

Constructors

Constructor and Description
ConfluenceMacro(org.randombits.support.core.env.EnvironmentAssistant environmentAssistant, com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent) Deprecated. Use ConfluenceMacro(MacroAssistant) instead.
ConfluenceMacro(MacroAssistant macroAssistant)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeMacroInfo(MacroInfo info) This method is called to close the MacroInstance created by createMacroInfo(java.util.Map, String, com.atlassian.confluence.content.render.xhtml.ConversionContext) By default it simply calls MacroInfo.close()
protected MacroInfo	createMacroInfo(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String body, com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext) This method is called to create a new MacroInfo instance.
protected abstract java.lang.String	execute(MacroInfo info) Returns XHTML or plain text content (depending on the value returned from Macro.getBodyType()
java.lang.String	execute(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String body, com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext)
protected org.randombits.support.core.env.EnvironmentAssistant	getEnvironmentAssistant()
MacroAssistant	getMacroAssistant()
org.randombits.support.core.param.ParameterAssistant	getParameterAssistant()
com.atlassian.confluence.xhtml.api.XhtmlContent	getXhtmlContent()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.macro.Macro

getBodyType, getOutputType

Constructor Detail

ConfluenceMacro

public ConfluenceMacro(MacroAssistant macroAssistant)

ConfluenceMacro

@Deprecated
public ConfluenceMacro(org.randombits.support.core.env.EnvironmentAssistant environmentAssistant,
                          com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent)

Deprecated. Use ConfluenceMacro(MacroAssistant) instead.

Parameters:

environmentAssistant - The EnvironmentAssistant.

xhtmlContent - The XhtmlContent.

Method Detail

execute

public java.lang.String execute(java.util.Map<java.lang.String,java.lang.String> params,
                       java.lang.String body,
                       com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext)
                         throws com.atlassian.confluence.macro.MacroExecutionException

Specified by:

execute in interface com.atlassian.confluence.macro.Macro

Throws:

com.atlassian.confluence.macro.MacroExecutionException

getEnvironmentAssistant

protected org.randombits.support.core.env.EnvironmentAssistant getEnvironmentAssistant()

createMacroInfo

protected MacroInfo createMacroInfo(java.util.Map<java.lang.String,java.lang.String> params,
                        java.lang.String body,
                        com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext)
                             throws com.atlassian.confluence.macro.MacroExecutionException

This method is called to create a new MacroInfo instance. Override it to return other subclasses if so desired.

Parameters:

params - The macro parameter map.

body - The body of the macro.

conversionContext - The conversion context.

Returns:

The new MacroInfo instance.

Throws:

com.atlassian.confluence.macro.MacroExecutionException - if there is a problem while process.ing.

closeMacroInfo

protected void closeMacroInfo(MacroInfo info)

This method is called to close the MacroInstance created by createMacroInfo(java.util.Map, String, com.atlassian.confluence.content.render.xhtml.ConversionContext) By default it simply calls MacroInfo.close()

Parameters:

info - The context to close.

execute

protected abstract java.lang.String execute(MacroInfo info)
                                     throws com.atlassian.confluence.macro.MacroExecutionException

Returns XHTML or plain text content (depending on the value returned from Macro.getBodyType()

Parameters:

info - The macro context.

Returns:

The XHTML or wiki content.

Throws:

com.atlassian.confluence.macro.MacroExecutionException - if there is a problem while executing.

getXhtmlContent

public com.atlassian.confluence.xhtml.api.XhtmlContent getXhtmlContent()

getParameterAssistant

public org.randombits.support.core.param.ParameterAssistant getParameterAssistant()

getMacroAssistant

public MacroAssistant getMacroAssistant()