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

Class TemplateResource.Builder

java.lang.Object

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

Enclosing class:

TemplateResource

public static class TemplateResource.Builder
extends Object

Option Builder for template resources.

Constructor Summary

Constructors

Constructor and Description
TemplateResource.Builder(String template)
TemplateResource.Builder(String template, boolean inline)

Method Summary

Methods

Modifier and Type	Method and Description
TemplateResource.Builder	addEngineOption(String key, Object value)
TemplateResource.Builder	addParameter(String key, Object value)
TemplateResource	build()
protected String	getDescription()
protected String	getEngineName()
protected Map<String,Object>	getEngineOptions()
protected String	getMimeType()
protected Map<String,Object>	getParameters()
protected String	getTemplate()
protected boolean	isInline()
TemplateResource.Builder	setDescription(String desc)
TemplateResource.Builder	setEngineName(String name)
TemplateResource.Builder	setEngineName(com.github.bordertech.wcomponents.template.TemplateRendererFactory.TemplateEngine engine)
TemplateResource.Builder	setMimeType(String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateResource.Builder

public TemplateResource.Builder(String template)

Parameters:

template - the template resource name

TemplateResource.Builder

public TemplateResource.Builder(String template,
                        boolean inline)

Parameters:

template - the template resource name

inline - true if stream inline

Method Detail

isInline

protected boolean isInline()

Returns:

true if stream inline

getTemplate

protected String getTemplate()

Returns:

the template resource name

getEngineName

protected String getEngineName()

Returns:

the template engine name

getDescription

protected String getDescription()

Returns:

the resource description

getMimeType

protected String getMimeType()

Returns:

the resource mime type

getParameters

protected Map<String,Object> getParameters()

Returns:

the template parameters

getEngineOptions

protected Map<String,Object> getEngineOptions()

Returns:

the template engine options

setEngineName

public TemplateResource.Builder setEngineName(com.github.bordertech.wcomponents.template.TemplateRendererFactory.TemplateEngine engine)

Parameters:

engine - the template engine

Returns:

the builder

setEngineName

public TemplateResource.Builder setEngineName(String name)

Parameters:

name - the template engine name

Returns:

the builder

setDescription

public TemplateResource.Builder setDescription(String desc)

Parameters:

desc - the resource description

Returns:

the builder

setMimeType

public TemplateResource.Builder setMimeType(String type)

Parameters:

type - the resource mime type

Returns:

the builder

addParameter

public TemplateResource.Builder addParameter(String key,
                                    Object value)

Parameters:

key - the template parameter key

value - the template parameter value

Returns:

the builder

addEngineOption

public TemplateResource.Builder addEngineOption(String key,
                                       Object value)

Parameters:

key - the engine option key

value - the engine option value

Returns:

the builder

build

public TemplateResource build()

Returns:

build the template resource