com.atlassian.confluence.content.render.xhtml
Interface ConversionContext

All Known Implementing Classes:

DefaultConversionContext

public interface ConversionContext

Since:

4.0

Method Summary

ContentTree	getContentTree() If multiple items are being converted in this 'context' then the complete tree of ContentNodes will be retrieved via this method.
ContentEntityObject	getEntity() Get the current ContentEntityObject for this context.
String	getOutputType()
PageContext	getPageContext() This method should be considered almost deprecated.
Object	getProperty(String name) Return a property from the context.
String	getPropertyAsString(String name) Returns the property for this key as a String.
String	getSpaceKey() The spacekey for the current context if applicable or null otherwise.
boolean	hasProperty(String name) Returns true if the property with the specified key has been set.
Object	removeProperty(String name) Removes the property references by the key from the conversion context and returns it.
void	setProperty(String name, Object value) Sets the property specified by name in the conversion context.

Method Detail

setProperty

void setProperty(String name,
                 Object value)

Sets the property specified by name in the conversion context.

Parameters:

name - A unique key for this property. See ConversionContextPropertyName for common names.

value - The value of the property.

getPageContext

PageContext getPageContext()

This method should be considered almost deprecated.

At the moment a ConversionContext implementation will always be wrapping at least a RenderContext and as long as this is actually a PageContext then it will be returned by this method. However, at some point in the future ConversionContext will be decoupled from the old v2 RenderContext and this method will be removed.

Returns:

the underlying PageContext wrapped by the ConversionContext.

See Also:

DefaultConversionContext

removeProperty

Object removeProperty(String name)

Removes the property references by the key from the conversion context and returns it.

Parameters:

name - The unique key of the property. See ConversionContextPropertyName for common names.

Returns:

The property from the conversion context.

getProperty

Object getProperty(String name)

Return a property from the context.

Parameters:

name - of the property. See ConversionContextPropertyName for common names.

Returns:

a property from the context.

getPropertyAsString

String getPropertyAsString(String name)

Returns the property for this key as a String. toString() will be called if this is not the java.lang.String class. null will be returned if this property does not exist.

Parameters:

name - The key for the property

Returns:

The String value of the property or null if the property does not exist.

hasProperty

boolean hasProperty(String name)

Returns true if the property with the specified key has been set.

Parameters:

name - The name of the property

Returns:

True if the property exists in this context.

getContentTree

ContentTree getContentTree()

If multiple items are being converted in this 'context' then the complete tree of ContentNodes will be retrieved via this method. If only a single item is being converted in the context then a ContentTree containing a single ContentNode will be returned.

Returns:

a ContentTree representing all the items being converted in this context. An empty ContentTree may be returned if there is no explicit content being converted in this context.

getOutputType

String getOutputType()

Returns:

one of the Strings returned by ConversionContextOutputType.value() which indicates the target output type for the conversion.

getEntity

ContentEntityObject getEntity()

Get the current ContentEntityObject for this context.

Returns:

The ContentEntityObject for this context.

getSpaceKey

String getSpaceKey()

The spacekey for the current context if applicable or null otherwise.

Returns:

The spacekey or null.