com.atlassian.renderer.v2

Class V2Renderer

java.lang.Object

com.atlassian.renderer.v2.V2Renderer

All Implemented Interfaces:

MutableRenderer, Renderer

public class V2Renderer
extends Object
implements MutableRenderer

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Category	log
static String	RENDERER_TYPE

Constructor Summary

Constructors

Constructor and Description
V2Renderer()
V2Renderer(List components)

Method Summary

Methods

Modifier and Type	Method and Description
String	getRendererType() Returns a unique type that describes the renderer.
String	render(String wiki, RenderContext renderContext) Render some content without changing render modes.
String	renderAsText(String originalContent, RenderContext context) Render some content as text, performing any transforms that may be needed to produce nicely formatted text.
void	setComponents(List components)

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Category log

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

V2Renderer

public V2Renderer()

V2Renderer

public V2Renderer(List components)

Method Detail

setComponents

public void setComponents(List components)

Specified by:

setComponents in interface MutableRenderer

render

public String render(String wiki,
            RenderContext renderContext)

Description copied from interface: Renderer

Render some content without changing render modes.

Specified by:

render in interface Renderer

Parameters:

wiki - the content to render

renderContext - the context in which it is being rendered

Returns:

the resulting HTML

renderAsText

public String renderAsText(String originalContent,
                  RenderContext context)

Description copied from interface: Renderer

Render some content as text, performing any transforms that may be needed to produce nicely formatted text.

Specified by:

renderAsText in interface Renderer

Parameters:

originalContent - is the content to render.

Returns:

a string that represents the text of the original content which has been stripped of any markup characters that need not be indexed by lucene.

getRendererType

public String getRendererType()

Description copied from interface: Renderer

Returns a unique type that describes the renderer.

Specified by:

getRendererType in interface Renderer

Returns:

a string that uniquely identifies the renderer.