freemarker.template.instruction
Class BreakInstruction

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

All Implemented Interfaces:

Instruction, TemplateProcessor, java.io.Serializable

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

An instruction that represents a break in execution, either within a case statement of a switch, or within a list or foreach loop.

Note:
BreakInstruction is a singleton instance. Use the getInstance() method to retrieve instances of this instruction.

Since:

1.8.1

See Also:

ListInstruction, SwitchInstruction, 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

Method Summary

TemplateProcessor	callBuilder(TemplateBuilder builder) A TemplateBuilder can call this method to have an Instruction call it back to be built.
static BreakInstruction	getInstance() Retrieves a singleton instance of BreakInstruction.
short	process(TemplateWriteableHashModel modelRoot, java.io.Writer out, TemplateRuntimeHandler eventHandler) Processes the contents of this TemplateProcessor and outputs the resulting text to a Writer.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class freemarker.template.instruction.EmptyInstruction

getEndType, isEndInstruction

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static BreakInstruction getInstance()

Retrieves a singleton instance of BreakInstruction.

Returns:

a singleton BreakInstruction

callBuilder

public TemplateProcessor callBuilder(TemplateBuilder builder)
                              throws ParseException

A TemplateBuilder can call this method to have an Instruction call it back to be built. This implementation returns immediately, since there is nothing additional to be parsed within this instruction.

Specified by:

callBuilder in interface Instruction

Overrides:

callBuilder in class EmptyInstruction

Parameters:

builder - the builder to be called back by this method

Throws:

ParseException

process

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

Processes the contents of this TemplateProcessor and outputs the resulting text to a Writer. This implementation returns immediately, since there is nothing to output.

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:

1, to indicate this is a break instruction

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

the String "break"