freemarker.core

Class ReturnInstruction

java.lang.Object

freemarker.core.TemplateObject

freemarker.core.TemplateElement

freemarker.core.ReturnInstruction

All Implemented Interfaces:

TreeNode

public final class ReturnInstruction
extends TemplateElement

Represents a <return> instruction to jump out of a macro.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReturnInstruction.Return

Method Summary

Modifier and Type	Method and Description
protected String	dump(boolean canonical) Brings the implementation of TemplateElement.getCanonicalForm() and TemplateElement.getDescription() to a single place.

Methods inherited from class freemarker.core.TemplateElement

children, getAllowsChildren, getCanonicalForm, getChildAt, getChildCount, getChildNodes, getDescription, getIndex, getNodeName, getNodeNamespace, getNodeType, getParent, getParentNode, isLeaf, setChildAt

Methods inherited from class freemarker.core.TemplateObject

contains, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getEndLocation, getEndLocationQuoted, getSource, getStartLocation, getStartLocationQuoted, getTemplate, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

dump

protected String dump(boolean canonical)

Description copied from class: TemplateElement

Brings the implementation of TemplateElement.getCanonicalForm() and TemplateElement.getDescription() to a single place. Don't call those methods in method on this, because that will result in infinite recursion!

Specified by:

dump in class TemplateElement

Parameters:

canonical - if true, it calculates the return value of TemplateElement.getCanonicalForm(), otherwise of TemplateElement.getDescription().