com.google.clearsilver.jsilver

Interface TemplateRenderer

All Known Implementing Classes:

ClearsilverRenderer, JSilver

public interface TemplateRenderer

Renders a template.

Method Summary

Methods

Modifier and Type	Method and Description
String	render(String templateName, Data data) Same as render(String, Data, Appendable), except returns rendered template as a String.
void	render(String templateName, Data data, Appendable output) Same as render(String, Data, Appendable, ResourceLoader), except it uses the default ResourceLoader passed in to the JSilver constructor.
void	render(String templateName, Data data, Appendable output, ResourceLoader resourceLoader) Renders a given template and provided data, writing to an arbitrary output.
String	render(Template template, Data data) Same as render(Template,Data,Appendable), except returns rendered template as a String.
void	render(Template template, Data data, Appendable output) Same as render(Template,Data,Appendable,ResourceLoader), except it uses the ResourceLoader passed into the JSilver constructor.
void	render(Template template, Data data, Appendable output, ResourceLoader resourceLoader) Renders a given template and provided data, writing to an arbitrary output.
String	renderFromContent(String content, Data data) Same as renderFromContent(String, Data, Appendable), except returns rendered template as a String.
void	renderFromContent(String content, Data data, Appendable output) Renders a given template from the content passed in.

Method Detail

render

void render(String templateName,
          Data data,
          Appendable output,
          ResourceLoader resourceLoader)
            throws IOException,
                   JSilverException

Renders a given template and provided data, writing to an arbitrary output.

Parameters:

templateName - Name of template to load (e.g. "things/blah.cs").

data - Data to be used in template.

output - Where template should be rendered to. This can be a Writer, PrintStream, System.out/err), StringBuffer/StringBuilder or anything that implements java.io.Appendable

resourceLoader - ResourceLoader to use when reading in included files.

Throws:

IOException

JSilverException

render

void render(String templateName,
          Data data,
          Appendable output)
            throws IOException,
                   JSilverException

Same as render(String, Data, Appendable, ResourceLoader), except it uses the default ResourceLoader passed in to the JSilver constructor.

Throws:

IOException

JSilverException

render

String render(String templateName,
            Data data)
              throws IOException,
                     JSilverException

Same as render(String, Data, Appendable), except returns rendered template as a String.

Throws:

IOException

JSilverException

render

void render(Template template,
          Data data,
          Appendable output,
          ResourceLoader resourceLoader)
            throws IOException,
                   JSilverException

Renders a given template and provided data, writing to an arbitrary output.

Parameters:

template - Template to render.

data - Data to be used in template.

output - Where template should be rendered to. This can be a Writer, PrintStream, System.out/err), StringBuffer/StringBuilder or anything that implements java.io.Appendable.

resourceLoader - ResourceLoader to use when reading in included files.

Throws:

IOException

JSilverException

render

void render(Template template,
          Data data,
          Appendable output)
            throws IOException,
                   JSilverException

Same as render(Template,Data,Appendable,ResourceLoader), except it uses the ResourceLoader passed into the JSilver constructor.

Throws:

IOException

JSilverException

render

String render(Template template,
            Data data)
              throws IOException,
                     JSilverException

Same as render(Template,Data,Appendable), except returns rendered template as a String.

Throws:

IOException

JSilverException

renderFromContent

void renderFromContent(String content,
                     Data data,
                     Appendable output)
                       throws IOException,
                              JSilverException

Renders a given template from the content passed in. That is, the first parameter is the actual template content rather than the filename to load.

Parameters:

content - Content of template (e.g. "Hello <cs var:name ?>").

data - Data to be used in template.

output - Where template should be rendered to. This can be a Writer, PrintStream, System.out/err), StringBuffer/StringBuilder or anything that implements java.io.Appendable

Throws:

IOException

JSilverException

renderFromContent

String renderFromContent(String content,
                       Data data)
                         throws IOException,
                                JSilverException

Same as renderFromContent(String, Data, Appendable), except returns rendered template as a String.

Throws:

IOException

JSilverException