Package com.atlassian.confluence.renderer.template

Interface TemplateRenderer

All Known Implementing Classes:

ConfluenceSoyTemplateRenderer, DelegatingTemplateRenderer

public interface TemplateRenderer

Generic interface for rendering templates where the templating engine may be provided by a plugin.

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.

Method Detail

renderTo

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

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

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

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

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

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

Since:

5.8

renderTo

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

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

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

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

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

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

The - Streamable rendered result

Throws:

TemplateRenderingException - if something goes wrong during the rendering

Since:

5.8