freemarker.template.instruction
Class CommentInstruction

java.lang.Object
  |
  +--freemarker.template.instruction.CommentInstruction
All Implemented Interfaces:
ContainerInstruction, Instruction, java.io.Serializable, TemplateProcessor, UnparsedInstruction

public final class CommentInstruction
extends java.lang.Object
implements UnparsedInstruction, java.io.Serializable

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.

Version:
$Id: CommentInstruction.java,v 1.23 2003/11/27 11:36:45 run2000 Exp $
See Also:
Serialized Form

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

getInstance

public static CommentInstruction getInstance()
Return a singleton instance of a comment instruction.
Returns:
a singleton CommentInstruction object

isEndInstruction

public boolean isEndInstruction()
Is this an end instruction?
Specified by:
isEndInstruction in interface Instruction
Returns:
false, indicating that this is not an end instruction

getEndType

public int getEndType()
Determine what type of end instruction this is, if any.
Specified by:
getEndType in interface Instruction
Returns:
NONE, indicating that this is not an end instruction

callBuilder

public TemplateProcessor callBuilder(TemplateBuilder builder)
                              throws ParseException
Call the TemplateBuilder with this comment instruction.
Specified by:
callBuilder in interface Instruction
Parameters:
builder - the TemplateBuilder to be called back

setText

public void setText(java.lang.String text)
Sets the text of the comment.
Specified by:
setText in interface UnparsedInstruction
Parameters:
text - the text of the comment

testEndInstruction

public boolean testEndInstruction(Instruction endInstruction)
Is this the right kind of instruction for the given EndInstruction?
Specified by:
testEndInstruction in interface ContainerInstruction
Parameters:
endInstruction - the end instruction we're testing
Returns:
true if the EndInstruction is a comment end instruction, otherwise false

process

public void process(TemplateModelRoot modelRoot,
                    java.io.Writer out,
                    TemplateRuntimeHandler eventHandler)
Process this <comment> instruction.
Specified by:
process in interface TemplateProcessor
Parameters:
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.

toString

public java.lang.String toString()
Returns a string representation of the object.
Overrides:
toString in class java.lang.Object
Returns:
The String "comment"