com.atlassian.confluence.renderer.template
Interface TemplateRenderer

All Known Implementing Classes:

DelegatingTemplateRenderer

public interface TemplateRenderer

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

Method Summary

void	renderTo(java.lang.Appendable appendable, java.lang.String templateProviderPluginKey, java.lang.String templateName, java.util.Map<java.lang.String,java.lang.Object> data) Render a plugin-provided template to a Writer.
void	renderTo(java.lang.Appendable appendable, java.lang.String templateProviderPluginKey, java.lang.String templateName, java.util.Map<java.lang.String,java.lang.Object> data, java.util.Map<java.lang.String,java.lang.Object> injectedData) Render a plugin-provided template to a Writer.

Method Detail

renderTo

void renderTo(java.lang.Appendable appendable,
              java.lang.String templateProviderPluginKey,
              java.lang.String templateName,
              java.util.Map<java.lang.String,java.lang.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

renderTo

void renderTo(java.lang.Appendable appendable,
              java.lang.String templateProviderPluginKey,
              java.lang.String templateName,
              java.util.Map<java.lang.String,java.lang.Object> data,
              java.util.Map<java.lang.String,java.lang.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