Interface IPostProcessor
-
- All Known Implementing Classes:
PostProcessor
public interface IPostProcessorInterface defining post-processors.
Post-processors are implementations of
ITemplateHandlermeant to be executed on template model events after these events have gone through processing by all the applicable processors (implementations ofIProcessor).Post-processors can be used to re-shape the template processing output just before output is really produced.
Most of the times, the
PostProcessorimplementation will be used for registering post-processors.- Since:
- 3.0.0
- Author:
- Daniel Fernández
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Class<? extends ITemplateHandler>getHandlerClass()Returns the handler class for this post-processor, theITemplateHandlerthat implements the real logic to be executed.intgetPrecedence()Returns the precedence that should be applied to this post-processor.TemplateModegetTemplateMode()Returns the template mode this post-processor should be executed for.
-
-
-
Method Detail
-
getTemplateMode
TemplateMode getTemplateMode()
Returns the template mode this post-processor should be executed for. A post-processor can only be linked to a specific template mode.
- Returns:
- the template mode.
-
getPrecedence
int getPrecedence()
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).- Returns:
- the post-processor precedence.
-
getHandlerClass
Class<? extends ITemplateHandler> getHandlerClass()
Returns the handler class for this post-processor, the
ITemplateHandlerthat implements the real logic to be executed.In order for post-processors to work correctly, they need to implement correctly all the
ITemplateHandlercontract. In order to make this easier, extendingAbstractTemplateHandleris recommended.- Returns:
- the handler class.
-
-