Package net.officefloor.web.template.section

Interface WebTemplateWriter

All Known Implementing Classes:

BeanWebTemplateWriter, LinkWebTemplateWriter, PropertyWebTemplateWriter, StaticWebTemplateWriter

public interface WebTemplateWriter

Interface to write the template content to ServerWriter.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	write(ServerWriter writer, boolean isDefaultCharset, Object bean, ServerHttpConnection connection, String templatePath)	Writes the template content to the ServerWriter.

Method Details

write

void write(ServerWriter writer,
 boolean isDefaultCharset,
 Object bean,
 ServerHttpConnection connection,
 String templatePath)
    throws HttpException

Writes the template content to the ServerWriter.

Parameters:

writer - ServerWriter to receive the template content.

isDefaultCharset - Indicates if the default Charset for outputting the template is being used. While the Charset may be programmatically changed, it is expected in the majority of cases to be using the default Charset configured for the template. This flag allows static content to be cached in bytes (using default Charset) for improved performance.

bean - Bean to potentially obtain data. May be null if template contents does not require a bean.

connection - ServerHttpConnection.

templatePath - Current path for the WebTemplate. As the path may be dynamic (contain path parameters), this is the path to be used by links in rending of the WebTemplate.

Throws:

HttpException - If fails to write content.