org.randombits.support.confluence

Class MacroInfo

java.lang.Object

org.randombits.support.confluence.RequestInfo

org.randombits.support.confluence.PageInfo

org.randombits.support.confluence.MacroInfo

public class MacroInfo
extends PageInfo

This class provides some convenience functions commonly used in macros.

Author:

David Peterson

Field Summary

Fields

Modifier and Type	Field and Description
protected com.atlassian.confluence.content.render.xhtml.ConversionContext	conversionContext
static java.lang.String	MACRO_BODY This is the parameter value that is used to store the macro body in the macro parameter Map.

Constructor Summary

Constructors

Constructor and Description
MacroInfo(org.randombits.storage.IndexedStorage params, java.lang.String body, com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext, org.randombits.support.core.env.EnvironmentAssistant environmentAssistant, com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent) Deprecated. Use MacroInfo(org.randombits.storage.IndexedStorage, String, com.atlassian.confluence.content.render.xhtml.ConversionContext, MacroAssistant) instead.
MacroInfo(org.randombits.storage.IndexedStorage params, java.lang.String body, com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext, MacroAssistant macroAssistant)
MacroInfo(org.randombits.storage.IndexedStorage macroParams, java.lang.String body, MacroInfo info, org.randombits.support.core.env.EnvironmentAssistant environmentAssistant, com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent) Deprecated. Use MacroInfo(org.randombits.storage.IndexedStorage, String, com.atlassian.confluence.content.render.xhtml.ConversionContext, MacroAssistant) instead.
MacroInfo(org.randombits.storage.IndexedStorage macroParams, java.lang.String body, MacroInfo info, MacroAssistant macroAssistant)
MacroInfo(MacroInfo info) Constructs a new copy of the specified macro info.
MacroInfo(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String body, com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext, org.randombits.support.core.env.EnvironmentAssistant environmentAssistant, com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent) Deprecated. Use MacroInfo(java.util.Map, String, com.atlassian.confluence.content.render.xhtml.ConversionContext, MacroAssistant) instead.
MacroInfo(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String body, com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext, MacroAssistant macroAssistant)

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.confluence.macro.MacroExecutionContext	asMacroExecutionContext()
void	close() Call this method to indicate the class can free up its resources.
protected org.randombits.support.core.param.ParameterSource	createParameterSource()
static org.randombits.storage.IndexedStorage	createParameterStorage(java.util.Map<java.lang.String,java.lang.String> params) Creates a new IndexedStorage.
com.atlassian.confluence.content.render.xhtml.ConversionContext	getConversionContext()
org.randombits.storage.Storage	getConversionContextParams()
static com.atlassian.confluence.content.render.xhtml.ConversionContext	getCurrentConversionContext()
MacroAssistant	getMacroAssistant()
java.lang.String	getMacroBody()
org.randombits.storage.IndexedStorage	getMacroParams()
<T extends org.randombits.support.core.param.Parameters> T	getMacroParams(java.lang.Class<T> paramsClass)
java.util.Map<java.lang.String,java.lang.String>	getMacroParamsMap() Returns the original macro parameter map.
java.util.List<com.atlassian.confluence.xhtml.api.MacroDefinition>	getPageMacros() Deprecated. No replacement. Inject XhtmlContent and handle it directly if required.
org.randombits.support.core.param.ParameterAssistant	getParameterAssistant()
com.atlassian.confluence.xhtml.api.XhtmlContent	getXhtmlContent()

Methods inherited from class org.randombits.support.confluence.PageInfo

getContent, getContentProperties, getCurrentContent, getCurrentUser, getSpace, setContent

Methods inherited from class org.randombits.support.confluence.RequestInfo

finalize, getEnvironmentAssistant, getRequest, getRequestAttributes, getRequestParams, getSession, getSessionAttributes

Methods inherited from class java.lang.Object

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

Field Detail

MACRO_BODY

public static final java.lang.String MACRO_BODY

This is the parameter value that is used to store the macro body in the macro parameter Map.

See Also:

Constant Field Values

conversionContext

protected com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext

Constructor Detail

MacroInfo

@Deprecated
public MacroInfo(java.util.Map<java.lang.String,java.lang.String> params,
                    java.lang.String body,
                    com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext,
                    org.randombits.support.core.env.EnvironmentAssistant environmentAssistant,
                    com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent)
          throws com.atlassian.confluence.macro.MacroExecutionException

Deprecated. Use MacroInfo(java.util.Map, String, com.atlassian.confluence.content.render.xhtml.ConversionContext, MacroAssistant) instead.

Parameters:

conversionContext - The page context the macro is being rendered in.

environmentAssistant - The environment assistant.

xhtmlContent - The xhtmlContent.

body - The body of the macro.

params - The macro parameter map.

Throws:

com.atlassian.confluence.macro.MacroExecutionException - if there is a problem processing the parameters.

MacroInfo

@Deprecated
public MacroInfo(org.randombits.storage.IndexedStorage params,
                    java.lang.String body,
                    com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext,
                    org.randombits.support.core.env.EnvironmentAssistant environmentAssistant,
                    com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent)

Deprecated. Use MacroInfo(org.randombits.storage.IndexedStorage, String, com.atlassian.confluence.content.render.xhtml.ConversionContext, MacroAssistant) instead.

Constructs a MacroInfo.

Parameters:

params -

body -

conversionContext -

environmentAssistant -

xhtmlContent -

MacroInfo

@Deprecated
public MacroInfo(org.randombits.storage.IndexedStorage macroParams,
                    java.lang.String body,
                    MacroInfo info,
                    org.randombits.support.core.env.EnvironmentAssistant environmentAssistant,
                    com.atlassian.confluence.xhtml.api.XhtmlContent xhtmlContent)

Deprecated. Use MacroInfo(org.randombits.storage.IndexedStorage, String, com.atlassian.confluence.content.render.xhtml.ConversionContext, MacroAssistant) instead.

Constructs a MacroInfo.

Parameters:

macroParams -

body -

info -

environmentAssistant -

xhtmlContent -

MacroInfo

public MacroInfo(MacroInfo info)

Constructs a new copy of the specified macro info. All storage

Parameters:

info - The macro info to clone.

MacroInfo

public MacroInfo(org.randombits.storage.IndexedStorage params,
         java.lang.String body,
         com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext,
         MacroAssistant macroAssistant)

MacroInfo

public MacroInfo(java.util.Map<java.lang.String,java.lang.String> params,
         java.lang.String body,
         com.atlassian.confluence.content.render.xhtml.ConversionContext conversionContext,
         MacroAssistant macroAssistant)

Parameters:

conversionContext - The page context the macro is being rendered in.

macroAssistant - The environment assistant.

body - The body of the macro.

params - The macro parameter map.

Throws:

com.atlassian.confluence.macro.MacroExecutionException - if there is a problem processing the parameters.

MacroInfo

public MacroInfo(org.randombits.storage.IndexedStorage macroParams,
         java.lang.String body,
         MacroInfo info,
         MacroAssistant macroAssistant)

Method Detail

getCurrentConversionContext

public static com.atlassian.confluence.content.render.xhtml.ConversionContext getCurrentConversionContext()

createParameterStorage

public static org.randombits.storage.IndexedStorage createParameterStorage(java.util.Map<java.lang.String,java.lang.String> params)

Creates a new IndexedStorage.

Parameters:

params - The parameter map.

Returns:

The storage instance.

Throws:

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

getPageMacros

@Deprecated
public java.util.List<com.atlassian.confluence.xhtml.api.MacroDefinition> getPageMacros()
                                                                                 throws com.atlassian.confluence.content.render.xhtml.XhtmlException

Deprecated. No replacement. Inject XhtmlContent and handle it directly if required.

Get all the Xhtml MacroDefinitions on this page See 3.2 of - http://confluence.atlassian.com/display/CONFDEV/Creating+a+new+Confluence+4.0+Macro

Returns:

a list of MacroDefinitions

Throws:

com.atlassian.confluence.content.render.xhtml.XhtmlException - if t here is an issue parsing the macro definition list.

asMacroExecutionContext

public com.atlassian.confluence.macro.MacroExecutionContext asMacroExecutionContext()

getMacroBody

@API(value="4.0.0")
public java.lang.String getMacroBody()

Returns:

the body of the macro.

getMacroParams

@API(value="4.0.0")
public org.randombits.storage.IndexedStorage getMacroParams()

Returns:

a storage object allowing access to the macro's parameters.

getMacroParams

public <T extends org.randombits.support.core.param.Parameters> T getMacroParams(java.lang.Class<T> paramsClass)

createParameterSource

protected org.randombits.support.core.param.ParameterSource createParameterSource()

getMacroParamsMap

public java.util.Map<java.lang.String,java.lang.String> getMacroParamsMap()

Returns the original macro parameter map. If the MacroInfo was created with a constructor that passed in a IndexedStorage which was unable to be turned back into the original map, this may return an empty Map even though there are actually parameters via getMacroParams().

Returns:

The macro parameter map.

getConversionContext

public com.atlassian.confluence.content.render.xhtml.ConversionContext getConversionContext()

getConversionContextParams

public org.randombits.storage.Storage getConversionContextParams()

getXhtmlContent

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

close

public void close()

Description copied from class: RequestInfo

Call this method to indicate the class can free up its resources. Any call to methods on this instance after calling close may throw unexpected errors.

Overrides:

close in class PageInfo

getParameterAssistant

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

getMacroAssistant

public MacroAssistant getMacroAssistant()