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,v 1.1.1.1 2004/10/16 14:55:04 run2000 Exp $

See Also:

Serialized Form

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

AssignInstruction(Identifier variable, Expression value)
Constructor that takes a vairable to be assigned and the expression whose value should be assigned.

Method Summary

TemplateProcessor.ExitStatus	process(TemplateModelRoot modelRoot, java.io.Writer out, TemplateRuntimeHandler eventHandler) Process this <assign ...
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

AssignInstruction

public AssignInstruction(Identifier 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

Method Detail

process

public TemplateProcessor.ExitStatus process(TemplateModelRoot 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 model

out - a Writer to send the output to

eventHandler - 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