freemarker.template.instruction
Class VariableInstruction

java.lang.Object
  freemarker.template.instruction.EmptyInstruction
      freemarker.template.instruction.VariableInstruction

All Implemented Interfaces:

Instruction, TemplateProcessor, java.io.Serializable

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

An instruction that outputs the value of a Variable.

Version:

$Id: VariableInstruction.java 1162 2013-04-20 12:04:32Z run2000 $

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

VariableInstruction(Expression expression, boolean escaped)
Constructor that takes a Expression to be output.

Method Summary

TemplateProcessor.ExitStatus	process(TemplateProcessorParameters p) 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,
                           boolean escaped)

Constructor that takes a Expression to be output.

Parameters:

expression - the expression to be output

Throws:

java.lang.NullPointerException - the expression was null

java.lang.IllegalArgumentException - the expression was not a scalar nor a number

Method Detail

process

public TemplateProcessor.ExitStatus process(TemplateProcessorParameters p)
                                     throws java.io.IOException

Process this ${ ... } instruction.

Specified by:

process in interface TemplateProcessor

Parameters:

p - template processing parameters

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