freemarker.template.instruction
Class VariableInstruction

java.lang.Object
  |
  +--freemarker.template.instruction.EmptyInstruction
        |
        +--freemarker.template.instruction.VariableInstruction
All Implemented Interfaces:
Instruction, java.io.Serializable, TemplateProcessor

public final class VariableInstruction
extends EmptyInstruction
implements java.io.Serializable

An instruction that outputs the value of a Variable.

Version:
$Id: VariableInstruction.java,v 1.22 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
 
Constructor Summary
VariableInstruction(Expression expression)
          Constructor that takes a Expression to be output.
 
Method Summary
 void process(TemplateModelRoot modelRoot, java.io.Writer out, TemplateRuntimeHandler eventHandler)
          Process this ${ ...
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class freemarker.template.instruction.EmptyInstruction
callBuilder, getEndType, isEndInstruction
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VariableInstruction

public VariableInstruction(Expression expression)
Constructor that takes a Expression to be output.
Parameters:
expression - the expression to be output
Throws:
NullPointerException - the expression was null
java.lang.IllegalArgumentException - the expression was not a scalar nor a number
Method Detail

process

public void process(TemplateModelRoot modelRoot,
                    java.io.Writer out,
                    TemplateRuntimeHandler eventHandler)
             throws java.io.IOException
Process this ${ ... } instruction.
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:
a String representing this instruction subtree