freemarker.template.instruction
Class AssignInstruction
java.lang.Object
freemarker.template.instruction.EmptyInstruction
freemarker.template.instruction.AssignInstruction
- All Implemented Interfaces:
- Instruction, TemplateProcessor, java.io.Serializable
public final class AssignInstruction
- extends EmptyInstruction
- implements java.io.Serializable
An instruction that assigns a literal or reference to a single-identifier
variable.
- Version:
- $Id: AssignInstruction.java 1124 2005-10-04 10:48:45Z run2000 $
- See Also:
- Serialized Form
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
AssignInstruction
public AssignInstruction(Variable variable,
Expression value)
- Constructor that takes a vairable to be assigned and the expression
whose value should be assigned.
- Parameters:
variable
- the variable to assign to.value
- the expression to assign.
- Throws:
java.lang.NullPointerException
- the variable or value is null
java.lang.IllegalArgumentException
- attempt to assign variable to an iterator
process
public TemplateProcessor.ExitStatus process(TemplateWriteableHashModel modelRoot,
java.io.Writer out,
TemplateRuntimeHandler eventHandler)
throws java.io.IOException
- Process this
<assign ... >
instruction.
- Specified by:
process
in interface TemplateProcessor
- Parameters:
modelRoot
- the root node of the data modelout
- a Writer
to send the output toeventHandler
- a TemplateEventAdapter
for handling any
events that occur during processing
- Returns:
- an exit code indicating how the process terminated, typically
used for short-circuiting template processing
- Throws:
java.io.IOException
- an IO error occurred 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