fr.sii.ogham.template.freemarker.builder

Class AbstractFreemarkerMultiContentBuilder<MYSELF extends AbstractFreemarkerMultiContentBuilder<MYSELF,P>,P>

java.lang.Object

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

fr.sii.ogham.template.freemarker.builder.AbstractFreemarkerBuilder<MYSELF,P>

fr.sii.ogham.template.freemarker.builder.AbstractFreemarkerMultiContentBuilder<MYSELF,P>

All Implemented Interfaces:

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

Direct Known Subclasses:

FreemarkerEmailBuilder

public abstract class AbstractFreemarkerMultiContentBuilder<MYSELF extends AbstractFreemarkerMultiContentBuilder<MYSELF,P>,P>
extends AbstractFreemarkerBuilder<MYSELF,P>
implements VariantBuilder<MYSELF>

Field Summary

Fields inherited from class fr.sii.ogham.template.freemarker.builder.AbstractFreemarkerBuilder

buildContext, myself

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

parent

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
VariantResolver	buildVariant() Instantiates and configures the variant resolution based on previously defined variants.
MYSELF	variant(Variant variant, String extension) Registers a custom variant with its extension.

Methods inherited from class fr.sii.ogham.template.freemarker.builder.AbstractFreemarkerBuilder

build, buildAdapter, buildDetector, buildResolver, buildResolvers, classLoader, classpath, configuration, configuration, detector, file, mergeConfiguration, resolver, resolverAdapter, 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

Constructor Detail

AbstractFreemarkerMultiContentBuilder

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

Method Detail

variant

public MYSELF variant(Variant variant,
                      String extension)

Description copied from interface: VariantBuilder

Registers a custom variant with its extension. The aim is to be able to define a custom extension that is independent of the template parser and automatically load templates without specifying the extension allowing to mix several template parsers. For example, Freemarker is configured that way:

 .variant(EmailVariant.HTML, "html.ftl")
 .variant(EmailVariant.TEXT, "txt.ftl")
 

And Thymeleaf is configured that way:

 .variant(EmailVariant.HTML, "html")
 .variant(EmailVariant.TEXT, "txt")
 

Then when you send an email using templates:

 messagingService.send(new Email()
                // use default predefined variants (EmailVariant.TEXT and
                // EmailVariant.HTML)
                .content(new MultiTemplateContent("simple", new SimpleBean("foo", 42))));
 

You can either use different template files:

• "simple.html" and "simple.txt" that will be both handled by Thymeleaf
• "simple.html.ftl" and "simple.txt.ftl" that will be both handled by Freemarker
• "simple.html" and "simple.txt.ftl", the first will be handled by Thymeleaf and the second by Freemarker
• "simple.html.ftl" and "simple.txt", the first will be handled by Freemarker and the second by Thymeleaf

Registering your custom variant like this:

 // for Freemarker 
 .variant(MyVariant, "foo")
 // for Thymeleaf
 .variant(MyVariant, "bar")
 

You can now use your own variant (your own extensions) for loading template files independently of the template parser.

 messagingService.send(new Email()
                // use your custom variant
                .content(new MultiTemplateContent("simple", new SimpleBean("foo", 42), EmailVariant.TEXT, MyVariant, EmailVariant.HTML)));
 

The system will load any template file with ".foo" or ".bar" extensions if they exist.

Specified by:

variant in interface VariantBuilder<MYSELF extends AbstractFreemarkerMultiContentBuilder<MYSELF,P>>

Parameters:

variant - the variant (may be a enum like EmailVariant)

extension - the extension that corresponds to the variant

Returns:

this instance for fluent chaining

buildVariant

public VariantResolver buildVariant()

Description copied from interface: VariantBuilder

Instantiates and configures the variant resolution based on previously defined variants.

Specified by:

buildVariant in interface VariantBuilder<MYSELF extends AbstractFreemarkerMultiContentBuilder<MYSELF,P>>

Returns:

the variant resolver