freemarker.template.instruction
Class CallInstruction

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

All Implemented Interfaces:

Instruction, TemplateProcessor, java.io.Serializable

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

An instruction representing a function call.

See Also:

Serialized Form

Field Summary

Fields inherited from interface freemarker.template.instruction.Instruction

ASSIGN_END, BREAK, CASE, COMMENT_END, COMPRESS_END, DEFAULT, ELSE, ELSEIF, FOREACH_END, FUNCTION_END, IF_END, LIST_END, NONE, NOPARSE_END, SWITCH_END, TRANSFORM_END

Fields inherited from interface freemarker.template.TemplateProcessor

BREAK, EXIT, OK, UNCOMPILED_TEMPLATE

Constructor Summary

CallInstruction(MethodCall methodCall)
Constructor for a function call.

Method Summary

short	process(TemplateWriteableHashModel modelRoot, java.io.Writer out, TemplateRuntimeHandler eventHandler) Process this <call ...
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

CallInstruction

public CallInstruction(MethodCall methodCall)

Constructor for a function call.

Parameters:

methodCall - the method call expression representing the arguments to be passed to the function

Throws:

java.lang.NullPointerException - the method call expression was null

Method Detail

process

public short process(TemplateWriteableHashModel modelRoot,
                     java.io.Writer out,
                     TemplateRuntimeHandler eventHandler)
              throws java.io.IOException

Process this <call ... >

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