Package org.thymeleaf.preprocessor

Class PreProcessor

java.lang.Object

org.thymeleaf.preprocessor.PreProcessor

All Implemented Interfaces:

IPreProcessor

public final class PreProcessor
extends java.lang.Object
implements IPreProcessor

Basic implementation of IPreProcessor.

This implementation will suffice for most of the scenarios in which specifying a pre-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
PreProcessor(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 pre-processor, the ITemplateHandler that implements the real logic to be executed.
int	getPrecedence()	Returns the precedence that should be applied to this pre-processor.
TemplateMode	getTemplateMode()	Returns the template mode this pre-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

PreProcessor

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

Method Detail

getTemplateMode

public final TemplateMode getTemplateMode()

Description copied from interface: IPreProcessor

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

Specified by:

getTemplateMode in interface IPreProcessor

Returns:

the template mode.

getPrecedence

public final int getPrecedence()

Description copied from interface: IPreProcessor

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

Specified by:

getPrecedence in interface IPreProcessor

Returns:

the pre-processor precedence.

getHandlerClass

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

Description copied from interface: IPreProcessor

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

In order for pre-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 IPreProcessor

Returns:

the handler class.