org.jbake.template

Class TemplateEngines

java.lang.Object

org.jbake.template.TemplateEngines

public class TemplateEngines
extends Object

A singleton class giving access to rendering engines. Rendering engines are loaded based on classpath. New rendering may be registered either at runtime (not recommanded) or by putting a descriptor file on classpath (recommanded).

The descriptor file must be found in META-INF directory and named org.jbake.parser.TemplateEngines.properties. The format of the file is easy:

org.jbake.parser.FreeMarkerRenderer=ftl
org.jbake.parser.GroovyRenderer=groovy,gsp


where the key is the class of the engine (must extend AbstractTemplateEngine and have a 4-arg constructor and the value is a comma-separated list of file extensions that this engine is capable of proceeding.

Rendering engines are singletons, so are typically used to initialize the underlying template engines.

This class loads the engines only if they are found on classpath. If not, the engine is not registered. This allows JBake to support multiple rendering engines without the explicit need to have them on classpath. This is a better fit for embedding.

Author:

Cédric Champeau

Constructor Summary

Constructors

Constructor and Description
TemplateEngines(org.apache.commons.configuration.CompositeConfiguration config, ContentStore db, File destination, File templatesPath)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractTemplateEngine	getEngine(String fileExtension)
Set<String>	getRecognizedExtensions()

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateEngines

public TemplateEngines(org.apache.commons.configuration.CompositeConfiguration config,
               ContentStore db,
               File destination,
               File templatesPath)

Method Detail

getRecognizedExtensions

public Set<String> getRecognizedExtensions()

getEngine

public AbstractTemplateEngine getEngine(String fileExtension)