Package com.peterphi.std.guice.web.rest.templating

Interface TemplateCall

All Known Implementing Classes:

FreemarkerCall, ThymeleafCall

public interface TemplateCall

Method Summary

Modifier and Type	Method	Description
String	getName()	Return this template name
String	process()	Render the template to a String
void	process(Writer writer)	Render the template to a Writer
javax.ws.rs.core.Response	process(javax.ws.rs.core.Response.ResponseBuilder responseBuilder)	Render the template as the entity for a ResponseBuilder, returning the built Response
TemplateCall	set(String name, Object value)	Sets a variable which is then exposed to the view layer
TemplateCall	setAll(Map<String,Object> values)	Sets a number of variables which are then exposed to the view layer

Method Details

getName

String getName()

Return this template name

Returns:

set

TemplateCall set(String name,
 Object value)

Sets a variable which is then exposed to the view layer

Parameters:

name -

value -

Returns:

setAll

TemplateCall setAll(Map<String,Object> values)

Sets a number of variables which are then exposed to the view layer

Parameters:

values -

Returns:

process

String process()

Render the template to a String

Returns:

process

void process(Writer writer)

Render the template to a Writer

process

javax.ws.rs.core.Response process(javax.ws.rs.core.Response.ResponseBuilder responseBuilder)

Render the template as the entity for a ResponseBuilder, returning the built Response

Returns:

the result of calling responseBuilder.