Package org.thymeleaf.processor.templateboundaries

Interface ITemplateBoundariesProcessor

All Superinterfaces:

IProcessor

All Known Implementing Classes:

AbstractTemplateBoundariesProcessor, StandardInlineEnablementTemplateBoundariesProcessor

public interface ITemplateBoundariesProcessor
extends IProcessor

Base interface for all processors that execute on template boundaries (i.e. template start and template end events).

Template Boundaries Processors are a kind of processors that execute on the template start and template end events fired during template processing. They allow to perform any kind of initialization or disposal of resources at beginning or end of the template processing operation. Note that these events are only fired for the first-level template, and not for each of the fragments that might be parsed and/or included into the template being processed.

Since:

3.0.0

Author:

Daniel Fernández

See Also:

AbstractTemplateBoundariesProcessor, ITemplateBoundariesStructureHandler

Method Summary

Modifier and Type	Method	Description
void	processTemplateEnd(ITemplateContext context, ITemplateEnd templateEnd, ITemplateBoundariesStructureHandler structureHandler)	Execute the processor for a ITemplateEnd event.
void	processTemplateStart(ITemplateContext context, ITemplateStart templateStart, ITemplateBoundariesStructureHandler structureHandler)	Execute the processor for a ITemplateStart event.

Methods inherited from interface org.thymeleaf.processor.IProcessor

getPrecedence, getTemplateMode

Method Detail

processTemplateStart

void processTemplateStart(ITemplateContext context,
                          ITemplateStart templateStart,
                          ITemplateBoundariesStructureHandler structureHandler)

Execute the processor for a ITemplateStart event.

The ITemplateStart object argument is immutable, so all modifications to this object or any instructions to be given to the engine should be done through the specified ITemplateBoundariesStructureHandler handler.

Parameters:

context - the execution context.

templateStart - the event this processor is executing on.

structureHandler - the handler that will centralise modifications and commands to the engine.

processTemplateEnd

void processTemplateEnd(ITemplateContext context,
                        ITemplateEnd templateEnd,
                        ITemplateBoundariesStructureHandler structureHandler)

Execute the processor for a ITemplateEnd event.

The ITemplateEnd object argument is immutable, so all modifications to this object or any instructions to be given to the engine should be done through the specified ITemplateBoundariesStructureHandler handler.

Parameters:

context - the execution context.

templateEnd - the event this processor is executing on.

structureHandler - the handler that will centralise modifications and commands to the engine.