Package org.thymeleaf.postprocessor

Class PostProcessor

java.lang.Object

org.thymeleaf.postprocessor.PostProcessor

All Implemented Interfaces:

IPostProcessor

public final class PostProcessor
extends java.lang.Object
implements IPostProcessor

Basic implementation of IPostProcessor.

This implementation will suffice for most of the scenarios in which specifying a post-processor at a dialect is needed.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Class<? extends ITemplateHandler>	handlerClass
private int	precedence
private TemplateMode	templateMode

Constructor Summary

Constructors

Constructor	Description
PostProcessor(TemplateMode templateMode, java.lang.Class<? extends ITemplateHandler> handlerClass, int precedence)

Method Summary

Modifier and Type	Method	Description
java.lang.Class<? extends ITemplateHandler>	getHandlerClass()	Returns the handler class for this post-processor, the ITemplateHandler that implements the real logic to be executed.
int	getPrecedence()	Returns the precedence that should be applied to this post-processor.
TemplateMode	getTemplateMode()	Returns the template mode this post-processor should be executed for.

Methods inherited from class java.lang.Object

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

Field Detail

templateMode

private final TemplateMode templateMode

handlerClass

private final java.lang.Class<? extends ITemplateHandler> handlerClass

precedence

private final int precedence

Constructor Detail

PostProcessor

public PostProcessor(TemplateMode templateMode,
                     java.lang.Class<? extends ITemplateHandler> handlerClass,
                     int precedence)

Method Detail

getTemplateMode

public final TemplateMode getTemplateMode()

Description copied from interface: IPostProcessor

Returns the template mode this post-processor should be executed for. A post-processor can only be linked to a specific template mode.

Specified by:

getTemplateMode in interface IPostProcessor

Returns:

the template mode.

getPrecedence

public final int getPrecedence()

Description copied from interface: IPostProcessor

Returns the precedence that should be applied to this post-processor. This will determine the order in which it will be executed in relation to any other post-processors (note that the dialect precedence determined by IPostProcessorDialect.getDialectPostProcessorPrecedence() will be applied first).

Specified by:

getPrecedence in interface IPostProcessor

Returns:

the post-processor precedence.

getHandlerClass

public final java.lang.Class<? extends ITemplateHandler> getHandlerClass()

Description copied from interface: IPostProcessor

Returns the handler class for this post-processor, the ITemplateHandler that implements the real logic to be executed.

In order for post-processors to work correctly, they need to implement correctly all the ITemplateHandler contract. In order to make this easier, extending AbstractTemplateHandler is recommended.

Specified by:

getHandlerClass in interface IPostProcessor

Returns:

the handler class.