bboss.org.apache.velocity

类 Template

java.lang.Object

bboss.org.apache.velocity.runtime.resource.Resource

bboss.org.apache.velocity.Template

public class Template
extends Resource

This class is used for controlling all template operations. This class uses a parser created by JavaCC to create an AST that is subsequently traversed by a Visitor.

 // set up and initialize Velocity before this code block

 Template template = Velocity.getTemplate("test.wm");
 Context context = new VelocityContext();

 context.put("foo", "bar");
 context.put("customer", new Customer());

 template.merge(context, writer);
 

字段概要

从类继承的字段 bboss.org.apache.velocity.runtime.resource.Resource

data, encoding, lastModified, MILLIS_PER_SECOND, modificationCheckInterval, name, nextCheck, resourceLoader, rsvc, type

构造器概要

构造器

构造器和说明
Template() Default constructor

方法概要

限定符和类型	方法和说明
void	initDocument() initializes the document.
void	merge(Context context, java.io.Writer writer) The AST node structure is merged with the context to produce the final output.
void	merge(Context context, java.io.Writer writer, java.util.List macroLibraries) The AST node structure is merged with the context to produce the final output.
boolean	process() gets the named resource as a stream, parses and inits

从类继承的方法 bboss.org.apache.velocity.runtime.resource.Resource

getData, getEncoding, getLastModified, getName, getResourceLoader, getType, isSourceModified, requiresChecking, setData, setEncoding, setLastModified, setModificationCheckInterval, setName, setResourceLoader, setRuntimeServices, setType, touch

从类继承的方法 java.lang.Object

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

构造器详细资料

Template

public Template()

Default constructor

方法详细资料

process

public boolean process()
                throws ResourceNotFoundException,
                       ParseErrorException

gets the named resource as a stream, parses and inits

指定者:

process 在类中 Resource

返回:

true if successful

抛出:

ResourceNotFoundException - if template not found from any available source.

ParseErrorException - if template cannot be parsed due to syntax (or other) error.

java.io.IOException - problem reading input stream

initDocument

public void initDocument()
                  throws TemplateInitException

initializes the document. init() is not longer dependant upon context, but we need to let the init() carry the template name down throught for VM namespace features

抛出:

TemplateInitException - When a problem occurs during the document initialization.

merge

public void merge(Context context,
                  java.io.Writer writer)
           throws ResourceNotFoundException,
                  ParseErrorException,
                  MethodInvocationException

The AST node structure is merged with the context to produce the final output.

参数:

context - Conext with data elements accessed by template

writer - output writer for rendered template

抛出:

ResourceNotFoundException - if template not found from any available source.

ParseErrorException - if template cannot be parsed due to syntax (or other) error.

MethodInvocationException - When a method on a referenced object in the context could not invoked.

merge

public void merge(Context context,
                  java.io.Writer writer,
                  java.util.List macroLibraries)
           throws ResourceNotFoundException,
                  ParseErrorException,
                  MethodInvocationException

The AST node structure is merged with the context to produce the final output.

参数:

context - Conext with data elements accessed by template

writer - output writer for rendered template

macroLibraries - a list of template files containing macros to be used when merging

抛出:

ResourceNotFoundException - if template not found from any available source.

ParseErrorException - if template cannot be parsed due to syntax (or other) error.

MethodInvocationException - When a method on a referenced object in the context could not invoked.

从以下版本开始:

1.6