com.atlassian.renderer.v2.components

Class MacroRendererComponent

java.lang.Object

com.atlassian.renderer.v2.components.AbstractRendererComponent

com.atlassian.renderer.v2.components.MacroRendererComponent

All Implemented Interfaces:

RendererComponent

public class MacroRendererComponent
extends AbstractRendererComponent

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSIDER_VARIABLE_FORMAT_PARAMETER By default if not provided by $RenderContext.getParam(Object), this parameter will be true, otherwise it is converted to a boolean to determine whether should consider ${...} as the variable format, and therefore skip in regards to our macro processing.

Constructor Summary

Constructors

Constructor and Description
MacroRendererComponent(MacroManager macroManager, SubRenderer subRenderer)

Method Summary

Modifier and Type	Method and Description
protected String	executeMacro(String command, Macro macro, Map<String,Object> params, String renderedBody, RenderContext context)
SubRenderer	getSubRenderer()
void	makeMacro(StringBuffer buffer, MacroTag startTag, String body, RenderContext context)
void	processMacro(String command, Macro macro, String body, Map<String,Object> params, RenderContext context, StringBuffer buffer)
String	render(String wiki, RenderContext context) Render this piece of wiki text.
boolean	shouldRender(RenderMode renderMode) Whether or not this render component is required given the current render mode.

Methods inherited from class java.lang.Object

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

Field Detail

CONSIDER_VARIABLE_FORMAT_PARAMETER

public static final String CONSIDER_VARIABLE_FORMAT_PARAMETER

By default if not provided by $RenderContext.getParam(Object), this parameter will be true, otherwise it is converted to a boolean to determine whether should consider ${...} as the variable format, and therefore skip in regards to our macro processing.

See Also:

Constant Field Values

Constructor Detail

MacroRendererComponent

public MacroRendererComponent(MacroManager macroManager,
                              SubRenderer subRenderer)

Method Detail

shouldRender

public boolean shouldRender(RenderMode renderMode)

Description copied from interface: RendererComponent

Whether or not this render component is required given the current render mode.

render

public String render(String wiki,
                     RenderContext context)

Description copied from interface: RendererComponent

Render this piece of wiki text.

makeMacro

public void makeMacro(StringBuffer buffer,
                      MacroTag startTag,
                      String body,
                      RenderContext context)

processMacro

public void processMacro(String command,
                         Macro macro,
                         String body,
                         Map<String,Object> params,
                         RenderContext context,
                         StringBuffer buffer)

executeMacro

protected String executeMacro(String command,
                              Macro macro,
                              Map<String,Object> params,
                              String renderedBody,
                              RenderContext context)
                       throws MacroException

Throws:

MacroException

getSubRenderer

public SubRenderer getSubRenderer()