juzu.template
Class Template.Builder

java.lang.Object
  juzu.template.Template.Builder

Enclosing class:

Template

public class Template.Builder
extends Object

A builder providing a fluent syntax for rendering a template.

Constructor Summary

Template.Builder()

Method Summary

Response.Content	notFound() Renders the template and set a 404 response on the current MimeContext.
Response.Content	ok() Renders the template and set the response on the current MimeContext.
Response.Render	render() Renders the template and returns a render response.
<A extends Appendable> A	renderTo(A appendable) Renders the template to the specified appendable, the current MimeContext will not be affected.
void	renderTo(Stream.Char printer) Renders the template to the specified printer, the current MimeContext will not be affected.
Template.Builder	set(String name, Object value) Update a parameter, if the value is not null the parameter with the specified name is set, otherwise the parameter is removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Template.Builder

public Template.Builder()

Method Detail

set

public Template.Builder set(String name,
                            Object value)
                     throws NullPointerException

Update a parameter, if the value is not null the parameter with the specified name is set, otherwise the parameter is removed. If the parameter is set and a value was set previously, the old value is overwritten otherwise. If the parameter is removed and the value does not exist, nothing happens.

Parameters:

name - the parameter name

value - the parameter value

Returns:

this builder

Throws:

NullPointerException - if the name argument is null

render

public Response.Render render()
                       throws TemplateExecutionException,
                              UndeclaredIOException

Renders the template and returns a render response.

Returns:

the render response

Throws:

TemplateExecutionException

UndeclaredIOException

ok

public final Response.Content ok()

Renders the template and set the response on the current MimeContext.

Returns:

the ok resource response

notFound

public final Response.Content notFound()

Renders the template and set a 404 response on the current MimeContext.

Returns:

the not found resource response

renderTo

public <A extends Appendable> A renderTo(A appendable)
                              throws TemplateExecutionException,
                                     UndeclaredIOException

Renders the template to the specified appendable, the current MimeContext will not be affected.

Parameters:

appendable - the appendable

Throws:

TemplateExecutionException - any execution exception

UndeclaredIOException - any io exception

renderTo

public void renderTo(Stream.Char printer)
              throws TemplateExecutionException,
                     UndeclaredIOException

Renders the template to the specified printer, the current MimeContext will not be affected.

Parameters:

printer - the printer

Throws:

TemplateExecutionException - any execution exception

UndeclaredIOException - any io exception