fr.sii.ogham.template.thymeleaf.v2.buider

Class ThymeleafV2EngineConfigBuilder<P>

java.lang.Object

fr.sii.ogham.core.fluent.AbstractParent<P>

fr.sii.ogham.template.thymeleaf.common.buider.AbstractThymeleafEngineConfigBuilder<ThymeleafV2EngineConfigBuilder<P>,P>

fr.sii.ogham.template.thymeleaf.v2.buider.ThymeleafV2EngineConfigBuilder<P>

Type Parameters:

P - the type of the parent builder (when calling AbstractParent.and() method)

All Implemented Interfaces:

Builder<org.thymeleaf.TemplateEngine>, Parent<P>

public class ThymeleafV2EngineConfigBuilder<P>
extends AbstractThymeleafEngineConfigBuilder<ThymeleafV2EngineConfigBuilder<P>,P>

Fluent builder to configure Thymeleaf engine.

Author:

Aurélien Baudet

Field Summary

Fields inherited from class fr.sii.ogham.template.thymeleaf.common.buider.AbstractThymeleafEngineConfigBuilder

buildContext, cacheManager, dialects, dialectsByPrefix, messageResolvers, myself, templateResolvers

Fields inherited from class fr.sii.ogham.core.fluent.AbstractParent

parent

Constructor Summary

Constructors

Constructor and Description
ThymeleafV2EngineConfigBuilder(P parent, BuildContext buildContext) Initializes the builder with a parent builder.

Method Summary

Modifier and Type	Method and Description
ThymeleafV2EngineConfigBuilder<P>	addTemplateModeHandler(org.thymeleaf.templatemode.ITemplateModeHandler templateModeHandler) Adds a Template Mode Handler to the set of Template Mode Handlers to be used by the template engine.
org.thymeleaf.TemplateEngine	build() Instantiate and configures the instance.
protected void	configureMessageResolvers(org.thymeleaf.TemplateEngine engine)
ThymeleafV2EngineConfigBuilder<P>	setDefaultMessageResolvers(Set<? extends org.thymeleaf.messageresolver.IMessageResolver> defaultMessageResolvers) Sets the default message resolvers.
ThymeleafV2EngineConfigBuilder<P>	setDefaultTemplateModeHandlers(Set<? extends org.thymeleaf.templatemode.ITemplateModeHandler> defaultTemplateModeHandlers) Sets the default Template Mode Handlers.
ThymeleafV2EngineConfigBuilder<P>	setTemplateModeHandlers(Set<? extends org.thymeleaf.templatemode.ITemplateModeHandler> templateModeHandlers) Sets the Template Mode Handlers to be used by this template engine.

Methods inherited from class fr.sii.ogham.template.thymeleaf.common.buider.AbstractThymeleafEngineConfigBuilder

addDialect, addDialect, addMessageResolver, addTemplateResolver, clearDialects, configureCacheManager, configureDialects, configureTemplateResolvers, dialects, dialectsByPrefix, messageResolvers, setAdditionalDialects, setCacheManager, setDialect, setDialects, setDialectsByPrefix, setMessageResolver, setMessageResolvers, setTemplateResolver, setTemplateResolvers, templateResolvers

Methods inherited from class fr.sii.ogham.core.fluent.AbstractParent

and

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThymeleafV2EngineConfigBuilder

public ThymeleafV2EngineConfigBuilder(P parent,
                                      BuildContext buildContext)

Initializes the builder with a parent builder. The parent builder is used when calling AbstractParent.and() method.

Parameters:

parent - the parent builder

buildContext - for registering instances and property evaluation

Method Detail

setTemplateModeHandlers

public ThymeleafV2EngineConfigBuilder<P> setTemplateModeHandlers(Set<? extends org.thymeleaf.templatemode.ITemplateModeHandler> templateModeHandlers)

Sets the Template Mode Handlers to be used by this template engine. Every available template mode must have its corresponding handler.

By default, template mode handlers set are StandardTemplateModeHandlers.ALL_TEMPLATE_MODE_HANDLERS

This operation can only be executed before processing templates for the first time. Once a template is processed, the template engine is considered to be initialized, and from then on any attempt to change its configuration will result in an exception.

Parameters:

templateModeHandlers - the Set of Template Mode Handlers.

Returns:

this for fluent use

addTemplateModeHandler

public ThymeleafV2EngineConfigBuilder<P> addTemplateModeHandler(org.thymeleaf.templatemode.ITemplateModeHandler templateModeHandler)

Adds a Template Mode Handler to the set of Template Mode Handlers to be used by the template engine. Every available template mode must have its corresponding handler.

By default, template mode handlers set are StandardTemplateModeHandlers.ALL_TEMPLATE_MODE_HANDLERS

This operation can only be executed before processing templates for the first time. Once a template is processed, the template engine is considered to be initialized, and from then on any attempt to change its configuration will result in an exception.

Parameters:

templateModeHandler - the new Template Mode Handler to be added.

Returns:

this for fluent use

setDefaultTemplateModeHandlers

public ThymeleafV2EngineConfigBuilder<P> setDefaultTemplateModeHandlers(Set<? extends org.thymeleaf.templatemode.ITemplateModeHandler> defaultTemplateModeHandlers)

Sets the default Template Mode Handlers. These are used when no Template Mode Handlers are set via the setTemplateModeHandlers(Set) or addTemplateModeHandler(ITemplateModeHandler) methods.

This method is useful for creating subclasses of TemplateEngine that establish default configurations for Template Mode Handlers.

By default, template mode handlers set are StandardTemplateModeHandlers.ALL_TEMPLATE_MODE_HANDLERS

This operation can only be executed before processing templates for the first time. Once a template is processed, the template engine is considered to be initialized, and from then on any attempt to change its configuration will result in an exception.

Parameters:

defaultTemplateModeHandlers - the default Template Mode Handlers.

Returns:

this for fluent use

setDefaultMessageResolvers

public ThymeleafV2EngineConfigBuilder<P> setDefaultMessageResolvers(Set<? extends org.thymeleaf.messageresolver.IMessageResolver> defaultMessageResolvers)

Sets the default message resolvers. These are used when no message resolvers are set via the AbstractThymeleafEngineConfigBuilder.setMessageResolver(IMessageResolver), AbstractThymeleafEngineConfigBuilder.setMessageResolvers(Set) or AbstractThymeleafEngineConfigBuilder.addMessageResolver(IMessageResolver) methods.

This method is useful for creating subclasses of TemplateEngine that establish default configurations for message resolvers.

This operation can only be executed before processing templates for the first time. Once a template is processed, the template engine is considered to be initialized, and from then on any attempt to change its configuration will result in an exception.

Parameters:

defaultMessageResolvers - the default message resolvers.

Returns:

this for fluent use

build

public org.thymeleaf.TemplateEngine build()

Description copied from interface: Builder

Instantiate and configures the instance.

Specified by:

build in interface Builder<org.thymeleaf.TemplateEngine>

Overrides:

build in class AbstractThymeleafEngineConfigBuilder<ThymeleafV2EngineConfigBuilder<P>,P>

Returns:

The built instance

configureMessageResolvers

protected void configureMessageResolvers(org.thymeleaf.TemplateEngine engine)

Overrides:

configureMessageResolvers in class AbstractThymeleafEngineConfigBuilder<ThymeleafV2EngineConfigBuilder<P>,P>