com.github.bordertech.wcomponents.addons.common.resource

Class TemplateResource

java.lang.Object

com.github.bordertech.wcomponents.addons.common.resource.TemplateResource

All Implemented Interfaces:

com.github.bordertech.wcomponents.ContentAccess, com.github.bordertech.wcomponents.ContentStreamAccess, Serializable

Direct Known Subclasses:

TemplateRegisterWclibJsResource

public class TemplateResource
extends Object
implements com.github.bordertech.wcomponents.ContentStreamAccess

Provide a Template as the Content Stream.

Author:

jonathan

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateResource.Builder Option Builder for template resources.

Constructor Summary

Constructors

Constructor and Description
TemplateResource(TemplateResource.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBytes()
String	getDescription()
String	getEngineName()
Map<String,Object>	getEngineOptions()
String	getMimeType()
Map<String,Object>	getParameters()
InputStream	getStream()
String	getTemplate()
boolean	isInline()
protected byte[]	processTemplate()

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateResource

public TemplateResource(TemplateResource.Builder builder)

Parameters:

builder - the resource builder

Method Detail

isInline

public boolean isInline()

Returns:

true if stream inline resource

getTemplate

public String getTemplate()

Returns:

the template resource name

getEngineName

public String getEngineName()

Returns:

the template engine name

getDescription

public String getDescription()

Specified by:

getDescription in interface com.github.bordertech.wcomponents.ContentAccess

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface com.github.bordertech.wcomponents.ContentAccess

getParameters

public Map<String,Object> getParameters()

Returns:

the template parameters

getEngineOptions

public Map<String,Object> getEngineOptions()

Returns:

the template engine options

getStream

public InputStream getStream()
                      throws IOException

Specified by:

getStream in interface com.github.bordertech.wcomponents.ContentStreamAccess

Throws:

IOException

getBytes

public byte[] getBytes()

Specified by:

getBytes in interface com.github.bordertech.wcomponents.ContentAccess

processTemplate

protected byte[] processTemplate()

Returns:

the template as a byte array