org.teatrove.tea.runtime
Class TemplateLoader

java.lang.Object
  org.teatrove.tea.runtime.TemplateLoader

public class TemplateLoader
extends Object

TemplateLoader manages the loading and execution of Tea templates. To reload templates, create a new TemplateLoader with a new ClassLoader.

Author:

Brian S O'Neill

See Also:

org.teatrove.tea.util.ClassInjector

Nested Class Summary

static interface

TemplateLoader.Template A ready-to-use Tea template.

Constructor Summary

TemplateLoader()
Creates a TemplateLoader that uses the current ClassLoader as a base.

TemplateLoader(ClassLoader baseLoader, String packagePrefix)
Creates a TemplateLoader that uses the given ClassLoader as a base.

TemplateLoader(String packagePrefix)
Creates a TemplateLoader that uses the current ClassLoader as a base.

Method Summary

TemplateLoader.Template[]	getLoadedTemplates() Returns all the templates that have been loaded thus far.
TemplateLoader.Template	getTemplate(String name) Get or load a template by its full name.
protected TemplateLoader.Template	loadTemplate(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateLoader

public TemplateLoader()

Creates a TemplateLoader that uses the current ClassLoader as a base. It is recommended that templates be compiled to a base package and that a TemplateLoader be constructed with the package prefix. This way, the TemplateLoader can easily distinguish between template classes and normal classes, only loading the templates.

TemplateLoader

public TemplateLoader(String packagePrefix)

Creates a TemplateLoader that uses the current ClassLoader as a base.

Parameters:

packagePrefix - Package that templates should be loaded from

TemplateLoader

public TemplateLoader(ClassLoader baseLoader,
                      String packagePrefix)

Creates a TemplateLoader that uses the given ClassLoader as a base. A base ClassLoader is used to load both template and non-template classes. The base ClassLoader can use the package prefix for determining whether or not it is loading a template.

Parameters:

baseLoader - Base ClassLoader

packagePrefix - Package that templates should be loaded from

Method Detail

getTemplate

public final TemplateLoader.Template getTemplate(String name)
                                          throws ClassNotFoundException,
                                                 NoSuchMethodException,
                                                 LinkageError

Get or load a template by its full name. The full name of a template has '.' characters to separate name parts, and it does not include a Java package prefix.

Throws:

ClassNotFoundException - when template not found

NoSuchMethodException - when the template is invalid

LinkageError

getLoadedTemplates

public final TemplateLoader.Template[] getLoadedTemplates()

Returns all the templates that have been loaded thus far.

loadTemplate

protected TemplateLoader.Template loadTemplate(String name)
                                        throws ClassNotFoundException,
                                               NoSuchMethodException,
                                               LinkageError

Throws:

ClassNotFoundException

NoSuchMethodException

LinkageError