freemarker.template
Interface TemplateProcessor

All Known Subinterfaces:

FunctionTemplateProcessor, UnparsedInstruction

All Known Implementing Classes:

AbstractTemplate, AssignBlockInstruction, AssignInstruction, BreakInstruction, CallInstruction, CaseInstruction, CommentInstruction, DefaultCaseInstruction, ElseInstruction, EmptyInstruction, ExitInstruction, FunctionInstruction, GenericStartInstruction, IfElseInstruction, IfInstruction, IncludeInstruction, ListInstruction, LocalInstruction, NOOPInstruction, NoParseInstruction, SwitchInstruction, Template, TemplateArrayList, TextBlockInstruction, TransformInstruction, UnparsedTemplate, VariableInstruction

public interface TemplateProcessor

Objects representing compiled templates must implement this interface.

Version:

$Id: TemplateProcessor.java 1101 2013-04-01 04:17:32Z run2000 $

Nested Class Summary

static class

TemplateProcessor.ExitStatus Enumates the return values from a template processor.

Method Summary

TemplateProcessor.ExitStatus

process(TemplateProcessorParameters p) Processes the contents of this TemplateProcessor and outputs the resulting text to a Writer.

Method Detail

process

TemplateProcessor.ExitStatus process(TemplateProcessorParameters p)
                                     throws java.io.IOException

Processes the contents of this TemplateProcessor and outputs the resulting text to a Writer.

Parameters:

p - template processing parameters

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