com.google.clearsilver.jsilver.template

Interface Template

All Known Subinterfaces:

Macro

All Known Implementing Classes:

BaseCompiledTemplate, BaseCompiledTemplate.CompiledMacro, InterpretedMacro, InterpretedTemplate

public interface Template

Represents a template that can be rendered with data.

Method Summary

Modifier and Type	Method and Description
RenderingContext	createRenderingContext(Data data, Appendable out, ResourceLoader resourceLoader) Create a new RenderingContext.
String	getDisplayName() Name to use when displaying error or log messages.
EscapeMode	getEscapeMode() Return the EscapeMode in which this template was generated.
String	getTemplateName() Name of template (e.g.
void	render(Data data, Appendable out, ResourceLoader resourceLoader) Render the template.
void	render(RenderingContext context) Render the template with a custom RenderingContext.

Method Detail

render

void render(Data data,
            Appendable out,
            ResourceLoader resourceLoader)
     throws IOException

Render the template.

Parameters:

data - Data to merge with template.

out - Target to write to.

resourceLoader - ResourceLoader to use instead of the default template one when loading files.

Throws:

IOException

render

void render(RenderingContext context)
     throws IOException

Render the template with a custom RenderingContext.

Parameters:

context - RenderingContext to use during rendering.

Throws:

IOException

createRenderingContext

RenderingContext createRenderingContext(Data data,
                                        Appendable out,
                                        ResourceLoader resourceLoader)

Create a new RenderingContext.

Parameters:

data - Data to merge with template.

out - Target to write to.

resourceLoader - ResourceLoader to load files.

getTemplateName

String getTemplateName()

Name of template (e.g. mytemplate.cs).

getDisplayName

String getDisplayName()

Name to use when displaying error or log messages. May return the same value as #getTemplateName, or may contain more information.

getEscapeMode

EscapeMode getEscapeMode()

Return the EscapeMode in which this template was generated.

Returns:

EscapeMode