freemarker.template.instruction
Class NOOPInstruction

java.lang.Object
  freemarker.template.instruction.NOOPInstruction

All Implemented Interfaces:

Instruction, TemplateProcessor, java.io.Serializable

public final class NOOPInstruction
extends java.lang.Object
implements Instruction, TemplateProcessor, java.io.Serializable

An instruction that does nothing. This is useful when we want to substitute one instruction for another. The best example of this is the way LinkedListTemplateBuilder deals with FunctionInstructions.

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

Version:

$Id: NOOPInstruction.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

Method Summary

TemplateProcessor	callBuilder(TemplateBuilder builder) A TemplateBuilder can call this method to have an Instruction call it back to be built.
Instruction.EndType	getEndType() Retrieve the type of end instruction, if any.
static NOOPInstruction	getInstance() Retrieves a singleton instance of NOOPInstruction.
boolean	isEndInstruction() Is this an end instruction?
TemplateProcessor.ExitStatus	process(TemplateProcessorParameters p) 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 java.lang.Object

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

Method Detail

getInstance

public static NOOPInstruction getInstance()

Retrieves a singleton instance of NOOPInstruction.

Returns:

a singleton NOOPInstruction

isEndInstruction

public boolean isEndInstruction()

Is this an end instruction?

Specified by:

isEndInstruction in interface Instruction

Returns:

false, indicating that this is not an end instruction

getEndType

public Instruction.EndType getEndType()

Retrieve the type of end instruction, if any.

Specified by:

getEndType in interface Instruction

Returns:

NONE, indicating that this is not an end instruction

callBuilder

public TemplateProcessor callBuilder(TemplateBuilder builder)

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

Parameters:

builder - the builder to be called back by this method

process

public TemplateProcessor.ExitStatus process(TemplateProcessorParameters p)

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:

p - template processing parameters

Returns:

an exit code indicating how the process terminated, typically used for short-circuiting template processing

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

the String "NOOP"