com.atlassian.confluence.renderer
Class RenderResult

java.lang.Object
  com.atlassian.confluence.renderer.RenderResult

public class RenderResult
extends java.lang.Object

The result of a wiki rendering: the main payload is, of course, the rendered content, but we may during the course of the render want to collect more information like page structure, or excerpts or so on, so this gives us a simple metadata facility.

Constructor Summary

RenderResult(java.lang.String renderedContent, java.util.Map metadata)

Method Summary

boolean	containsMetadata(java.lang.String key)
java.lang.Object	getMetadata(java.lang.String key)
java.lang.String	getRenderedContent()
java.lang.String	toString() Does the same as getRenderedContent, so you can shortcut the use of the renderer in things like writers or string concatenation.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderResult

public RenderResult(java.lang.String renderedContent,
                    java.util.Map metadata)

Method Detail

containsMetadata

public boolean containsMetadata(java.lang.String key)

getMetadata

public java.lang.Object getMetadata(java.lang.String key)

getRenderedContent

public java.lang.String getRenderedContent()

toString

public java.lang.String toString()

Does the same as getRenderedContent, so you can shortcut the use of the renderer in things like writers or string concatenation.

Overrides:

toString in class java.lang.Object

Returns:

the rendered content from the result.