com.fizzed.rocker.model

Interface TemplateModelPostProcessor

All Known Implementing Classes:

LoggingProcessor, WhitespaceRemovalProcessor

public interface TemplateModelPostProcessor

Classes implementing the TemplateModelPostProcessor interface can be used as post-processors of TemplateModels. To activate such post-processing, Rocker templates must be provided with the "postProcessing" option (@see RockerOptions.POST_PROCESSING), containing a comma-separated list of class names implementing this interface. The JavaGenerator then calls each given post-processor with the TemplateModel as argument immediately before the resulting template Java code is created.

Author:

jensfendler

Method Summary

Modifier and Type	Method and Description
TemplateModel	process(TemplateModel templateModel, int ppIndex) Performs any post-processing on the given TemplateModel as defined by the implementing class.

Method Detail

process

TemplateModel process(TemplateModel templateModel,
                      int ppIndex)
               throws PostProcessorException

Performs any post-processing on the given TemplateModel as defined by the implementing class. Only the returned instance shall be used further by the caller. Implementing classes may choose to return the provided instance, or create a completely new instance for further processing.

Parameters:

templateModel - the original template model (which might have already been processed by previous TemplateModelPostProcessors.

ppIndex - the index (starting from 0) of the post-processor as it appears in the list of given post-processor class names.

Returns:

the resulting TemplateModel which shall be used for further processing by following post-processors, or finally by the JavaGenerator.

Throws:

PostProcessorException