org.trimou.engine.listener

Interface MustacheListener

All Superinterfaces:

ConfigurationAware

All Known Implementing Classes:

AbstractMustacheListener, AbstractStatsCollector, EnhancedStatsCollector, SimpleStatsCollector

public interface MustacheListener
extends ConfigurationAware

Receives notifications about Mustache processing. A listener instance should only be registered for one MustacheEngine.

Listeners are invoked in the order of their registration, except for renderingFinished(MustacheRenderingEvent) method which is invoked in reverse order.

Code inside a listener may throw an unchecked exception - this aborts further processing of the template and no more listeners are invoked afterwards.

Any listener may implement optional interface Validateable. The validation is performed before a MustacheEngine is built. An invalid listener is not put into service, i.e. it's not included in the final list of listeners returned by Configuration.getMustacheListeners().

Author:

Martin Kouba

See Also:

MustacheEngineBuilder.addMustacheListener(MustacheListener)

Method Summary

Modifier and Type	Method and Description
default void	compilationFinished(MustacheCompilationEvent event) Notification that a Mustache template was just compiled.
default void	parsingStarted(MustacheParsingEvent event) Parsing of a Mustache is about to start.
default void	renderingFinished(MustacheRenderingEvent event) Rendering of a Mustache is about to finish.
default void	renderingStarted(MustacheRenderingEvent event) Rendering of a Mustache is about to start.

Methods inherited from interface org.trimou.engine.config.ConfigurationAware

getConfigurationKeys, init

Method Detail

compilationFinished

default void compilationFinished(MustacheCompilationEvent event)

Notification that a Mustache template was just compiled. Keep in mind that processing of a Lambda may also result in one-off template compilation - see also Lambda.isReturnValueInterpolated().

Parameters:

event -

renderingStarted

default void renderingStarted(MustacheRenderingEvent event)

Rendering of a Mustache is about to start. Always use ReleaseCallbackContainer.registerReleaseCallback(ReleaseCallback) to release all the necessary resources.

Parameters:

event -

renderingFinished

default void renderingFinished(MustacheRenderingEvent event)

Rendering of a Mustache is about to finish. Always use ReleaseCallbackContainer.registerReleaseCallback(ReleaseCallback) to release all the necessary resources.

Parameters:

event -

parsingStarted

default void parsingStarted(MustacheParsingEvent event)

Parsing of a Mustache is about to start. Listeners are allowed to modify the event payload, particularly the Reader object used by a parser to read the template contents.

Parameters:

event -