|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--freemarker.template.AbstractTemplate | +--freemarker.template.UnparsedTemplate
An UnparsedTemplate
consists only of text. No logic
beyond simple outputting is performed.
You can pass the filename of the template to the constructor, in which case it is read immediately. Once read, the unparsed template is stored in an an character array for later use.
To process the unparsed template, call the process(freemarker.template.TemplateModelRoot, java.io.Writer, freemarker.template.TemplateRuntimeHandler)
method,
which takes an optional tree of TemplateModel
objects as its
data model. The root node of the tree must be a TemplateModelRoot.
Any error messages will be included as HTML comments in the output.
To facilitate multithreading, UnparsedTemplate
objects are
immutable; if you need to recompile a template, you must make a new
UnparsedTemplate
object. In most cases, it will be sufficient
to let a TemplateCache
do this for you.
TemplateCache
, Serialized FormField Summary | |
protected char[] |
templateText
The unparsed template text. |
Fields inherited from class freemarker.template.AbstractTemplate |
cache |
Constructor Summary | |
UnparsedTemplate()
Constructs an empty unparsed template. |
|
UnparsedTemplate(java.io.File file)
Constructs an unparsed template by compiling it from a file. |
|
UnparsedTemplate(java.io.InputStream stream)
Constructs an unparsed template by compiling it from an InputStream . |
|
UnparsedTemplate(java.io.Reader stream)
Constructs an unparsed template by compiling it from a Reader . |
|
UnparsedTemplate(java.lang.String filePath)
Constructs an unparsed template by compiling it from a file. |
Method Summary | |
void |
compileFromStream(java.io.Reader stream)
Reads the unparsed template from a Reader . |
boolean |
equals(java.lang.Object o)
Tests this object for equality with the given object. |
int |
hashCode()
Retrieve the hash code for this object |
void |
process(TemplateModelRoot modelRoot,
java.io.Writer out)
Processes the template, using data from a template model, and outputs the resulting text to a Writer . |
void |
process(TemplateModelRoot modelRoot,
java.io.Writer out,
TemplateRuntimeHandler eventHandler)
Processes the contents of this UnparsedTemplate and
outputs the resulting text to a Writer . |
void |
process(java.io.Writer out)
Processes the template, using an empty data model, and outputs the resulting text to a Writer . |
java.lang.String |
toString()
Return the String value of this object |
Methods inherited from class freemarker.template.AbstractTemplate |
clone, compileFromFile, compileFromFile, compileFromStream, compileFromStream, getCache, setCache |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected char[] templateText
Constructor Detail |
public UnparsedTemplate()
public UnparsedTemplate(java.lang.String filePath) throws java.io.IOException
compileFromFile()
.filePath
- the absolute path of the template file
to be compiled.public UnparsedTemplate(java.io.File file) throws java.io.IOException
compileFromFile()
.file
- a File
representing the template file
to be compiled.public UnparsedTemplate(java.io.InputStream stream) throws java.io.IOException
InputStream
. Calls compileFromStream()
.stream
- an InputStream
from which the
template can be read.public UnparsedTemplate(java.io.Reader stream) throws java.io.IOException
Reader
. Calls compileFromStream()
.stream
- a Reader
from which the
template can be read.Method Detail |
public void compileFromStream(java.io.Reader stream) throws java.io.IOException
Reader
. If the template
has already been compiled, this method does nothing.compileFromStream
in class AbstractTemplate
stream
- a Reader
from which the
template can be read.public void process(TemplateModelRoot modelRoot, java.io.Writer out, TemplateRuntimeHandler eventHandler) throws java.io.IOException
UnparsedTemplate
and
outputs the resulting text to a Writer
.process
in class AbstractTemplate
modelRoot
- the root node of the data model.out
- a Writer
to send the output to.eventHandler
- a TemplateEventAdapter
for handling any
events that occur during processing.java.io.IOException
- an IO error occurred with the Writer
during processingpublic void process(TemplateModelRoot modelRoot, java.io.Writer out) throws java.io.IOException
Writer
.process
in class AbstractTemplate
modelRoot
- the root node of the data model.out
- a Writer
to output the text to.public void process(java.io.Writer out) throws java.io.IOException
Writer
.process
in class AbstractTemplate
out
- a Writer
to output the text to.public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- the object to be compared againsttrue
if the two objects are equal, otherwise
false
public int hashCode()
hashCode
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |