Interface IPostProcessor

  • All Known Implementing Classes:

    public interface IPostProcessor

    Interface defining post-processors.

    Post-processors are implementations of ITemplateHandler meant to be executed on template model events after these events have gone through processing by all the applicable processors (implementations of IProcessor).

    Post-processors can be used to re-shape the template processing output just before output is really produced.

    Most of the times, the PostProcessor implementation will be used for registering post-processors.

    Daniel Fernández
    • 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.

        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).

        the post-processor precedence.
      • getHandlerClass

        Class<? extends ITemplateHandler> getHandlerClass()

        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.

        the handler class.