fr.sii.ogham.template.thymeleaf.buider.ThymeleafSmsBuilder Maven / Gradle / Ivy

Go to download
package fr.sii.ogham.template.thymeleaf.buider;

import org.thymeleaf.TemplateEngine;

import fr.sii.ogham.core.builder.env.EnvironmentBuilder;
import fr.sii.ogham.sms.builder.SmsBuilder;

/**
 * Configures parsing of templates using Thymeleaf.
 * 
 * Specific resource resolution can be configured to use template prefix/suffix
 * paths:
 * 
 *  * 
 * .classpath()
 *   .pathPrefix("email/")
 *   .pathSuffix(".html")
 *   .and()
 * .file()
 *   .pathPrefix("/data/myapplication/templates/email")
 *   .pathSuffix(".html")
 * 
 * 
 * 
 * You can customize default Thymeleaf {@link TemplateEngine}:
 * 
 *  * 
 * .engine()
 *   .addDialect("foo", myDialect)
 *   .addMessageResolver(myMessageResolver)
 * 
 * 
 * 
 * Or you can use a particular Thymeleaf {@link TemplateEngine}:
 * 
 *  * 
 * .engine(new MyTemplateEngine())
 * 
 * 
 * 
 * @author Aurélien Baudet
 *
 */
public class ThymeleafSmsBuilder extends AbstractThymeleafBuilder {
	/**
	 * Default constructor when using Thymeleaf without all Ogham work.
	 * 
	 * WARNING: use is only if you know what you are doing !
	 */
	public ThymeleafSmsBuilder() {
		super(ThymeleafSmsBuilder.class);
	}

	/**
	 * Initializes the builder with a parent builder. The parent builder is used
	 * when calling {@link #and()} method. The {@link EnvironmentBuilder} is
	 * used to evaluate properties when {@link #build()} method is called.
	 * 
	 * @param parent
	 *            the parent builder
	 * @param environmentBuilder
	 *            the configuration for property resolution and evaluation
	 */
	public ThymeleafSmsBuilder(SmsBuilder parent, EnvironmentBuilder environmentBuilder) {
		super(ThymeleafSmsBuilder.class, parent, environmentBuilder);
	}
}