Package rife.template

Class TemplateFactory

java.lang.Object

rife.datastructures.EnumClass<String>

rife.template.TemplateFactory

public class TemplateFactory
extends EnumClass<String>

Factory for creating RIFE2 template instances.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static TemplateFactory	HTML
static TemplateFactory	JSON
static TemplateFactory	SQL
static TemplateFactory	SVG
static TemplateFactory	TXT
static TemplateFactory	XML

Fields inherited from class rife.datastructures.EnumClass

identifier_

Constructor Summary

Constructors

Constructor	Description
TemplateFactory(TemplateConfig config, String identifier, TemplateFactory base)
TemplateFactory(TemplateConfig config, ResourceFinder resourceFinder, String identifier, String defaultContentType, String extension, String[] blockFilters, String[] valueFilters, BeanHandler beanHandler, TemplateEncoder encoder, TemplateInitializer initializer)

Method Summary

Modifier and Type	Method	Description
void	generateTemplate(String name, String encoding, String generationPath)
Template	get(String name)	Creates a new Template instance for this factory using the default encoding.
Template	get(String name, String encoding)	Creates a new Template instance for this factory using the default encoding.
BeanHandler	getBeanHandler()
TemplateConfig	getConfig()
String	getDefaultContentType()
TemplateEncoder	getEncoder()
static TemplateFactory	getFactory(String identifier)
static Collection<String>	getFactoryTypes()
String	getIdentifierUppercase()
TemplateInitializer	getInitializer()
ResourceFinder	getResourceFinder()
Class	parse(String name, String encoding)
void	resetClassLoader()
TemplateFactory	setBeanHandler(BeanHandler beanHandler)
TemplateFactory	setEncoder(TemplateEncoder encoder)
TemplateFactory	setInitializer(TemplateInitializer initializer)
TemplateFactory	setResourceFinder(ResourceFinder resourceFinder)

Methods inherited from class rife.datastructures.EnumClass

equals, getIdentifier, getIdentifiers, getMember, getMembers, hashCode, registerType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

HTML

public static TemplateFactory HTML

XML

public static TemplateFactory XML

SVG

public static TemplateFactory SVG

TXT

public static TemplateFactory TXT

SQL

public static TemplateFactory SQL

JSON

public static TemplateFactory JSON

Constructor Details

TemplateFactory

public TemplateFactory(TemplateConfig config,
 ResourceFinder resourceFinder,
 String identifier,
 String defaultContentType,
 String extension,
 String[] blockFilters,
 String[] valueFilters,
 BeanHandler beanHandler,
 TemplateEncoder encoder,
 TemplateInitializer initializer)

TemplateFactory

public TemplateFactory(TemplateConfig config,
 String identifier,
 TemplateFactory base)

Method Details

getIdentifierUppercase

public String getIdentifierUppercase()

getDefaultContentType

public String getDefaultContentType()

getFactoryTypes

public static Collection<String> getFactoryTypes()

getFactory

public static TemplateFactory getFactory(String identifier)

get

public Template get(String name)
             throws TemplateException

Creates a new Template instance for this factory using the default encoding.

Please read get(String, String) for important additional information.

Parameters:

name - the name of the template

Returns:

the new template instance

Throws:

TemplateException - when an error occurred during the parsing or instantiation of the template

Since:

1.0

See Also:

• get(String, String)

get

public Template get(String name,
 String encoding)
             throws TemplateException

Creates a new Template instance for this factory using the default encoding.

RIFE2's templates are parsed and converted into JVM bytecode. Each template effectively becomes a highly optimized Java class that is loaded by the regular classloader. This limits the characters that can be used for template names to the characters that Java accepts for class names.

The characters that are invalid Java class name characters will be replaced by underscores, except for / and \, which will be replaced by dots. The changes to the template name will propagate through to the template source file name that RIFE2 is looking for.

Parameters:

name - the name of the template

encoding - the text encoding of the template file

Returns:

the new template instance

Throws:

TemplateException - when an error occurred during the parsing or instantiation of the template

Since:

1.0

See Also:

• get(String)

generateTemplate

public void generateTemplate(String name,
 String encoding,
 String generationPath)

parse

public Class parse(String name,
 String encoding)
            throws TemplateException

Throws:

TemplateException

getConfig

public TemplateConfig getConfig()

setResourceFinder

public TemplateFactory setResourceFinder(ResourceFinder resourceFinder)

getResourceFinder

public ResourceFinder getResourceFinder()

setBeanHandler

public TemplateFactory setBeanHandler(BeanHandler beanHandler)

getBeanHandler

public BeanHandler getBeanHandler()

setEncoder

public TemplateFactory setEncoder(TemplateEncoder encoder)

getEncoder

public TemplateEncoder getEncoder()

setInitializer

public TemplateFactory setInitializer(TemplateInitializer initializer)

getInitializer

public TemplateInitializer getInitializer()

resetClassLoader

public void resetClassLoader()