|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfreemarker.template.instruction.TextBlockInstruction
public final class TextBlockInstruction
A TemplateProcessor
representing a block of plain text.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface freemarker.template.instruction.Instruction |
---|
Instruction.EndType |
Nested classes/interfaces inherited from interface freemarker.template.TemplateProcessor |
---|
TemplateProcessor.ExitStatus |
Constructor Summary | |
---|---|
TextBlockInstruction(java.lang.String text)
Constructor that takes a block of text to be output. |
Method Summary | |
---|---|
TemplateProcessor |
callBuilder(TemplateBuilder builder)
A TemplateBuilder can call
this method to have an Instruction call it back to be built. |
Instruction.EndType |
getEndType()
Retrieve the type of end instruction, if any. |
boolean |
isEndInstruction()
Is this an end instruction? |
TemplateProcessor.ExitStatus |
process(TemplateWriteableHashModel modelRoot,
java.io.Writer out,
TemplateRuntimeHandler eventHandler)
Outputs the text. |
java.lang.String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TextBlockInstruction(java.lang.String text)
text
- the text block to be output at run time.Method Detail |
---|
public boolean isEndInstruction()
isEndInstruction
in interface Instruction
false
, indicating that this is not an end instructionpublic Instruction.EndType getEndType()
getEndType
in interface Instruction
NONE
, indicating that this is not an end instructionpublic TemplateProcessor callBuilder(TemplateBuilder builder)
TemplateBuilder
can call
this method to have an Instruction
call it back to be built.
This implementation returns immediately, since there is nothing additional
to be parsed within this instruction.
callBuilder
in interface Instruction
builder
- the builder to be called back by this methodpublic TemplateProcessor.ExitStatus process(TemplateWriteableHashModel modelRoot, java.io.Writer out, TemplateRuntimeHandler eventHandler) throws java.io.IOException
process
in interface TemplateProcessor
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 during processingpublic java.lang.String toString()
toString
in class java.lang.Object
String
representing this instruction subtree
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |