freemarker.template.instruction
Class NoParseInstruction

java.lang.Object
  freemarker.template.instruction.NoParseInstruction

All Implemented Interfaces:

ContainerInstruction, Instruction, UnparsedInstruction, TemplateProcessor, java.io.Serializable

public final class NoParseInstruction
extends java.lang.Object
implements UnparsedInstruction, java.io.Serializable

An instruction for containing an arbitrary block of text that is not parsed any further by FM-Classic.

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

NoParseInstruction()
Default constructor.

Method Summary

TemplateProcessor	callBuilder(TemplateBuilder builder) A TemplateBuilder can call this method to have an Instruction call it back to be built.
int	getEndType() Determine what type of end instruction this is, if any.
boolean	isEndInstruction() Is this an end instruction?
short	process(TemplateWriteableHashModel modelRoot, java.io.Writer out, TemplateRuntimeHandler eventHandler) Process this <noparse> instruction.
void	setText(java.lang.String text) Sets the text to be output when evaluating this instruction.
boolean	testEndInstruction(Instruction endInstruction) Is this the right kind of instruction for the given EndInstruction?
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

Constructor Detail

NoParseInstruction

public NoParseInstruction()

Default constructor.

Method Detail

setText

public void setText(java.lang.String text)

Sets the text to be output when evaluating this instruction.

Specified by:

setText in interface UnparsedInstruction

Parameters:

text - the text to be output

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 int getEndType()

Determine what type of end instruction this is, if any.

Specified by:

getEndType in interface Instruction

Returns:

NONE, indicating that this is not an end instruction

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 calls the TemplateBuilder.buildStatement(UnparsedInstruction) method, passing back a reference to itself. This approach is intended to make type-checking of Instruction objects unnecessary.

Specified by:

callBuilder in interface Instruction

Parameters:

builder - the builder to be called back by this method

Throws:

ParseException

testEndInstruction

public boolean testEndInstruction(Instruction endInstruction)

Is this the right kind of instruction for the given EndInstruction?

Specified by:

testEndInstruction in interface ContainerInstruction

Parameters:

endInstruction - the end instruction we're testing

Returns:

true if the EndInstruction is a noparse end instruction, otherwise false

process

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

Process this <noparse> instruction.

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