net.officefloor.plugin.web.http.template

Class BeanHttpTemplateWriter

java.lang.Object

net.officefloor.plugin.web.http.template.BeanHttpTemplateWriter

All Implemented Interfaces:

HttpTemplateWriter

public class BeanHttpTemplateWriter
extends Object
implements HttpTemplateWriter

HttpTemplateWriter to write a bean.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
BeanHttpTemplateWriter(net.officefloor.plugin.web.http.template.parse.BeanHttpTemplateSectionContent content, ValueRetriever<Object> valueRetriever, boolean isArray, HttpTemplateWriter[] beanWriters) Initiate.

Method Summary

Modifier and Type	Method and Description
void	write(ServerWriter writer, boolean isDefaultCharset, Object bean, HttpApplicationLocation location) Writes the template content to the ServerWriter.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanHttpTemplateWriter

public BeanHttpTemplateWriter(net.officefloor.plugin.web.http.template.parse.BeanHttpTemplateSectionContent content,
                              ValueRetriever<Object> valueRetriever,
                              boolean isArray,
                              HttpTemplateWriter[] beanWriters)
                       throws Exception

Initiate.

Parameters:

content - BeanHttpTemplateSectionContent.

valueRetriever - ValueRetriever.

isArray - Indicates if an array of beans to render.

beanWriters - HttpTemplateWriter instances for the bean.

Throws:

Exception - If Method to obtain the value to write is not available on the bean type.

Method Detail

write

public void write(ServerWriter writer,
                  boolean isDefaultCharset,
                  Object bean,
                  HttpApplicationLocation location)
           throws IOException

Description copied from interface: HttpTemplateWriter

Writes the template content to the ServerWriter.

Specified by:

write in interface HttpTemplateWriter

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.

location - HttpApplicationLocation to assist in providing web location.

Throws:

IOException - If fails to write content.