fr.sii.ogham.template.thymeleaf.common.buider

Class AbstractThymeleafBuilder<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>,P,E extends AbstractThymeleafEngineConfigBuilder<E,MYSELF>>

java.lang.Object

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

fr.sii.ogham.template.thymeleaf.common.buider.AbstractThymeleafBuilder<MYSELF,P,E>

All Implemented Interfaces:

Builder<TemplateParser>, ResourceResolutionBuilder<MYSELF>, DetectorBuilder<MYSELF>, Parent<P>

Direct Known Subclasses:

AbstractThymeleafMultiContentBuilder, ThymeleafV2SmsBuilder, ThymeleafV3SmsBuilder

public abstract class AbstractThymeleafBuilder<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>,P,E extends AbstractThymeleafEngineConfigBuilder<E,MYSELF>>
extends AbstractParent<P>
implements DetectorBuilder<MYSELF>, ResourceResolutionBuilder<MYSELF>, Builder<TemplateParser>

Field Summary

Fields

Modifier and Type	Field and Description
protected BuildContext	buildContext
protected ThymeleafContextConverter	contextConverter
protected List<TemplateResolverAdapter>	customAdapters
protected TemplateEngineDetector	detector
protected ConfigurationValueBuilderHelper<MYSELF,Boolean>	enableCacheValueBuilder
protected org.thymeleaf.TemplateEngine	engine
protected E	engineBuilder
protected MYSELF	myself
protected ResourceResolutionBuilderHelper<MYSELF>	resourceResolutionBuilderHelper

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

parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractThymeleafBuilder(Class<?> selfType)
protected	AbstractThymeleafBuilder(Class<?> selfType, P parent, BuildContext buildContext)
protected	AbstractThymeleafBuilder(P parent, BuildContext buildContext)

Method Summary

Modifier and Type	Method and Description
TemplateParser	build() Instantiate and configures the instance.
protected abstract FirstSupportingResolverAdapter	buildAdapters()
protected ThymeleafContextConverter	buildContext()
TemplateEngineDetector	buildDetector() Creates and configures the detector instance.
protected org.thymeleaf.TemplateEngine	buildEngine()
FirstSupportingResourceResolver	buildResolver() Builds the resolver used by Thymeleaf to resolve resources
protected abstract org.thymeleaf.templateresolver.ITemplateResolver	buildTemplateResolver(org.thymeleaf.TemplateEngine builtEngine)
protected TemplateResolverOptions	buildTemplateResolverOptions()
ConfigurationValueBuilder<MYSELF,Boolean>	cache() Enable/disable cache for templates.
MYSELF	cache(Boolean enable) Enable/disable cache for templates.
ClassPathResolutionBuilder<MYSELF>	classpath() Configure resource resolution based on classpath.
MYSELF	contextConverter(ThymeleafContextConverter converter) Ogham provides a generic context concept for template parsing.
protected abstract TemplateEngineDetector	createTemplateDetector()
MYSELF	detector(TemplateEngineDetector detector) Registers a detector to associate with a template parser.
E	engine() Fluent configurer for Thymeleaf engine configuration.
MYSELF	engine(org.thymeleaf.TemplateEngine engine) Sets a Thymeleaf engine.
FileResolutionBuilder<MYSELF>	file() Configure resource resolution based on filesystem.
protected abstract E	getThymeleafEngineConfigBuilder()
MYSELF	resolver(ResourceResolver resolver) Register a custom resolver.
MYSELF	resolverAdapter(TemplateResolverAdapter adapter) Ogham provides a generic resource resolution mechanism (ResourceResolver).
StringResolutionBuilder<MYSELF>	string() Configure lookup to use for direct string (when you provide directly the content of a file as string).

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

Field Detail

myself

protected final MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E> myself

buildContext

protected final BuildContext buildContext

detector

protected TemplateEngineDetector detector

resourceResolutionBuilderHelper

protected ResourceResolutionBuilderHelper<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>> resourceResolutionBuilderHelper

engine

protected org.thymeleaf.TemplateEngine engine

contextConverter

protected ThymeleafContextConverter contextConverter

engineBuilder

protected E extends AbstractThymeleafEngineConfigBuilder<E,MYSELF> engineBuilder

customAdapters

protected final List<TemplateResolverAdapter> customAdapters

enableCacheValueBuilder

protected final ConfigurationValueBuilderHelper<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>,Boolean> enableCacheValueBuilder

Constructor Detail

AbstractThymeleafBuilder

protected AbstractThymeleafBuilder(Class<?> selfType)

AbstractThymeleafBuilder

protected AbstractThymeleafBuilder(Class<?> selfType,
                                   P parent,
                                   BuildContext buildContext)

AbstractThymeleafBuilder

protected AbstractThymeleafBuilder(P parent,
                                   BuildContext buildContext)

Method Detail

cache

public MYSELF cache(Boolean enable)

Enable/disable cache for templates.

The value set using this method takes precedence over any property and default value configured using cache().

 .cache(false)
 .cache()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(true)
 

 .cache(false)
 .cache()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(true)
 

In both cases, cache(false) is used.

If this method is called several times, only the last value is used.

If null value is set, it is like not setting a value at all. The property/default value configuration is applied.

Parameters:

enable - enable or disable cache

Returns:

this instance for fluent chaining

cache

public ConfigurationValueBuilder<MYSELF,Boolean> cache()

Enable/disable cache for templates.

This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).

 .cache()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(true)
 

Non-null value set using cache(Boolean) takes precedence over property values and default value.

 .cache(false)
 .cache()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(true)
 

The value false is used regardless of the value of the properties and default value.

See ConfigurationValueBuilder for more information.

Returns:

the builder to configure property keys/default value

engine

public E engine()

Fluent configurer for Thymeleaf engine configuration.

Returns:

the fluent builder for Thymeleaf engine

engine

public MYSELF engine(org.thymeleaf.TemplateEngine engine)

Sets a Thymeleaf engine. This value preempts any other value defined by calling engine() method. If this method is called several times, only the last provider is used.

Parameters:

engine - the Thymeleaf engine

Returns:

this instance for fluent chaining

contextConverter

public MYSELF contextConverter(ThymeleafContextConverter converter)

Ogham provides a generic context concept for template parsing. Thymeleaf uses also a context concept. A context converter (ThymeleafContextConverter) is the way to transform an Ogham context into a Thymeleaf context.

Ogham provides and registers the default converter

If this method is called several times, only the last provider is used.

Parameters:

converter - the context converter

Returns:

this instance for fluent chaining

detector

public MYSELF detector(TemplateEngineDetector detector)

Description copied from interface: DetectorBuilder

Registers a detector to associate with a template parser. The detection can be based on:

• on the template name (may be the full template path)
• on the template variable substitutions
• on the template content

Specified by:

detector in interface DetectorBuilder<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>>

Parameters:

detector - the detector to register

Returns:

this instance for fluent chaining

classpath

public ClassPathResolutionBuilder<MYSELF> classpath()

Description copied from interface: ResourceResolutionBuilder

Configure resource resolution based on classpath.

You can define the lookup (the prefix that indicates that classpath resolution must be used). For example:

 .classpath().lookup("classpath:");
 
 // path prefixed by classpath: matches 
 // then classpath resolver is used
 resourceResolver.getResource("classpath:foo/bar.html");
 // path is not prefixed (or using another prefix) doesn't match 
 // then classpath resolver is not used
 resourceResolver.getResource("foo/bar.html");
 

You can define a path prefix and suffix for finding resources:

 .classpath().lookup("classpath:").pathPrefix("foo/").pathSuffix(".html");
 
 resourceResolver.getResource("classpath:bar");
 

This will use the classpath resolver and the real path is foo/bar.html.

Specified by:

classpath in interface ResourceResolutionBuilder<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>>

Returns:

the builder to configure classpath resolution

file

public FileResolutionBuilder<MYSELF> file()

Description copied from interface: ResourceResolutionBuilder

Configure resource resolution based on filesystem.

You can define the lookup (the prefix that indicates that filesystem resolution must be used). For example:

 .file().lookup("file:");
 
 // path prefixed by file: matches 
 // then file resolver is used
 resourceResolver.getResource("file:foo/bar.html");
 // path is not prefixed (or using another prefix) doesn't match 
 // then file resolver is not used
 resourceResolver.getResource("foo/bar.html");
 

You can define a path prefix and suffix for finding resources:

 .file().lookup("file:").pathPrefix("foo/").pathSuffix(".html");
 
 resourceResolver.getResource("file:bar");
 

This will use the file resolver and the real path is foo/bar.html.

Specified by:

file in interface ResourceResolutionBuilder<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>>

Returns:

the builder to configure file resolution

string

public StringResolutionBuilder<MYSELF> string()

Description copied from interface: ResourceResolutionBuilder

Configure lookup to use for direct string (when you provide directly the content of a file as string).

You can define the lookup (the prefix that indicates that direct string must be used). For example:

 .string().lookup("string:", "s:");
 
 // path prefixed by string: matches 
 // then string is used
 resourceResolver.getResource("string:hello world");
 // path is not prefixed (or using another prefix) doesn't match 
 // then string resolver is not used
 resourceResolver.getResource("foo/bar.html");
 

Specified by:

string in interface ResourceResolutionBuilder<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>>

Returns:

the builder to configure string resolution

resolver

public MYSELF resolver(ResourceResolver resolver)

Description copied from interface: ResourceResolutionBuilder

Register a custom resolver.

This may be useful to use a custom implementation that is able to load file content from anywhere.

The implementation may be aware of the lookup prefix (see AbstractPrefixedLookupPathResolver). The implementation may also use pathPrefix and pathSuffixes (see RelativeResolver and RelativisableResourceResolver).

Specified by:

resolver in interface ResourceResolutionBuilder<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>>

Parameters:

resolver - the custom resolver instance

Returns:

this instance for fluent chaining

resolverAdapter

public MYSELF resolverAdapter(TemplateResolverAdapter adapter)

Ogham provides a generic resource resolution mechanism (ResourceResolver). Thymeleaf uses its own template resolution mechanism (ITemplateResolver). A resolver adapter (TemplateResolverAdapter) is the way to transform a ResourceResolver into a ITemplateResolver.

Ogham provides and registers default resolver adapters but you may need to use a custom ResourceResolver. So you also need to provide the corresponding TemplateResolverAdapter.

Parameters:

adapter - the resolver adapter

Returns:

this instance for fluent chaining

build

public TemplateParser build()

Description copied from interface: Builder

Instantiate and configures the instance.

Specified by:

build in interface Builder<TemplateParser>

Returns:

The built instance

buildDetector

public TemplateEngineDetector buildDetector()

Description copied from interface: DetectorBuilder

Creates and configures the detector instance.

Specified by:

buildDetector in interface DetectorBuilder<MYSELF extends AbstractThymeleafBuilder<MYSELF,P,E>>

Returns:

the detector instance

buildResolver

public FirstSupportingResourceResolver buildResolver()

Builds the resolver used by Thymeleaf to resolve resources

Returns:

the resource resolver

buildEngine

protected org.thymeleaf.TemplateEngine buildEngine()

createTemplateDetector

protected abstract TemplateEngineDetector createTemplateDetector()

buildTemplateResolver

protected abstract org.thymeleaf.templateresolver.ITemplateResolver buildTemplateResolver(org.thymeleaf.TemplateEngine builtEngine)

getThymeleafEngineConfigBuilder

protected abstract E getThymeleafEngineConfigBuilder()

buildContext

protected ThymeleafContextConverter buildContext()

buildAdapters

protected abstract FirstSupportingResolverAdapter buildAdapters()

buildTemplateResolverOptions

protected TemplateResolverOptions buildTemplateResolverOptions()