Package com.atlassian.confluence.plugins.soy

Class ConfluenceSoyTemplateRenderer

java.lang.Object

com.atlassian.confluence.plugins.soy.ConfluenceSoyTemplateRenderer

All Implemented Interfaces:

TemplateRenderer

public class ConfluenceSoyTemplateRenderer
extends Object
implements TemplateRenderer

Confluence's agnostic shim for the Soy Template Renderer

Constructor Summary

Constructors

Constructor	Description
ConfluenceSoyTemplateRenderer(com.atlassian.soy.renderer.SoyTemplateRenderer delegate)

Method Summary

Modifier and Type	Method	Description
Streamable	render(String templateProviderPluginKey, String templateName, Map<String,Object> data)	Render a plugin-provided template as a Streamable.
Streamable	render(String templateProviderPluginKey, String templateName, Map<String,Object> data, Map<String,Object> injectedData)	Render a plugin-provided template as a Streamable.
void	renderTo(Appendable appendable, String templateProviderPluginKey, String templateName, Map<String,Object> data)	Render a plugin-provided template to a Writer.
void	renderTo(Appendable appendable, String templateProviderPluginKey, String templateName, Map<String,Object> data, Map<String,Object> injectedData)	Render a plugin-provided template to a Writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceSoyTemplateRenderer

public ConfluenceSoyTemplateRenderer(com.atlassian.soy.renderer.SoyTemplateRenderer delegate)

Method Detail

renderTo

public void renderTo(Appendable appendable,
                     String templateProviderPluginKey,
                     String templateName,
                     Map<String,Object> data)
              throws TemplateRenderingException

Description copied from interface: TemplateRenderer

Render a plugin-provided template to a Writer. The format of the data object to be passed in to the template is entirely dependent on the template implementation

Specified by:

renderTo in interface TemplateRenderer

Parameters:

appendable - the buffer to write the template output into

templateProviderPluginKey - the plugin that provides the template as a resource

templateName - the name of the plugin resource that contains the template

data - the data to pass into the template

Throws:

TemplateRenderingException - if something goes wrong during the rendering

render

public Streamable render(String templateProviderPluginKey,
                         String templateName,
                         Map<String,Object> data)
                  throws TemplateRenderingException

Description copied from interface: TemplateRenderer

Render a plugin-provided template as a Streamable. The format of the data object to be passed in to the template is entirely dependent on the template implementation

Specified by:

render in interface TemplateRenderer

Parameters:

templateProviderPluginKey - the plugin that provides the template as a resource

templateName - the name of the plugin resource that contains the template

data - the data to pass into the template

Returns:

The Streamable rendered result

Throws:

TemplateRenderingException - if something goes wrong during the rendering

renderTo

public void renderTo(Appendable appendable,
                     String templateProviderPluginKey,
                     String templateName,
                     Map<String,Object> data,
                     Map<String,Object> injectedData)
              throws TemplateRenderingException

Description copied from interface: TemplateRenderer

Render a plugin-provided template to a Writer. The format of the data object to be passed in to the template is entirely dependent on the template implementation

Specified by:

renderTo in interface TemplateRenderer

Parameters:

appendable - the buffer to write the template output into

templateProviderPluginKey - the plugin that provides the template as a resource

templateName - the name of the plugin resource that contains the template

data - the data to pass into the template

injectedData - injected data to pass into the template

Throws:

TemplateRenderingException - if something goes wrong during the rendering

render

public Streamable render(String templateProviderPluginKey,
                         String templateName,
                         Map<String,Object> data,
                         Map<String,Object> injectedData)
                  throws TemplateRenderingException

Description copied from interface: TemplateRenderer

Render a plugin-provided template as a Streamable. The format of the data object to be passed in to the template is entirely dependent on the template implementation

Specified by:

render in interface TemplateRenderer

Parameters:

templateProviderPluginKey - the plugin that provides the template as a resource

templateName - the name of the plugin resource that contains the template

data - the data to pass into the template

injectedData - injected data to pass into the template

Throws:

TemplateRenderingException - if something goes wrong during the rendering