|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--freemarker.template.instruction.CommentInstruction
An instruction for commenting out a block of text or adding a remark.
Note:
CommentInstruction
is a singleton instance. Use the
getInstance()
method to retrieve instances of this instruction.
Fields inherited from interface freemarker.template.instruction.Instruction |
BREAK, CASE, COMMENT_END, COMPRESS_END, DEFAULT, ELSE, ELSEIF, FOREACH_END, FUNCTION_END, IF_END, LIST_END, NONE, NOPARSE_END, SWITCH_END, TRANSFORM_END |
Method Summary | |
TemplateProcessor |
callBuilder(TemplateBuilder builder)
Call the TemplateBuilder with
this comment instruction. |
int |
getEndType()
Determine what type of end instruction this is, if any. |
static CommentInstruction |
getInstance()
Return a singleton instance of a comment instruction. |
boolean |
isEndInstruction()
Is this an end instruction? |
void |
process(TemplateModelRoot modelRoot,
java.io.Writer out,
TemplateRuntimeHandler eventHandler)
Process this <comment> instruction. |
void |
setText(java.lang.String text)
Sets the text of the comment. |
boolean |
testEndInstruction(Instruction endInstruction)
Is this the right kind of instruction for the given EndInstruction ? |
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 |
Method Detail |
public static CommentInstruction getInstance()
CommentInstruction
objectpublic boolean isEndInstruction()
isEndInstruction
in interface Instruction
false
, indicating that this is not an end instructionpublic int getEndType()
getEndType
in interface Instruction
NONE
, indicating that this is not an end instructionpublic TemplateProcessor callBuilder(TemplateBuilder builder) throws ParseException
TemplateBuilder
with
this comment instruction.callBuilder
in interface Instruction
builder
- the TemplateBuilder
to be called backpublic void setText(java.lang.String text)
setText
in interface UnparsedInstruction
text
- the text of the commentpublic boolean testEndInstruction(Instruction endInstruction)
EndInstruction
?testEndInstruction
in interface ContainerInstruction
endInstruction
- the end instruction we're testingtrue
if the EndInstruction
is a
comment end instruction, otherwise false
public void process(TemplateModelRoot modelRoot, java.io.Writer out, TemplateRuntimeHandler eventHandler)
<comment>
instruction.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.public java.lang.String toString()
toString
in class java.lang.Object
String
"comment
"
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |