Class PebbleEngine

java.lang.Object

io.pebbletemplates.pebble.PebbleEngine

public class PebbleEngine
extends Object

The main class used for compiling templates. The PebbleEngine is responsible for delegating responsibility to the lexer, parser, compiler, and template cache.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PebbleEngine.Builder	A builder to configure and construct an instance of a PebbleEngine.

Field Summary

Fields

Modifier and Type	Field	Description
private final Locale	defaultLocale
private final EvaluationOptions	evaluationOptions
private final ExecutorService	executorService
private final ExtensionRegistry	extensionRegistry
private final Loader<?>	loader
private final org.slf4j.Logger	logger
private final int	maxRenderedSize
private final ParserOptions	parserOptions
private final boolean	strictVariables
private final Syntax	syntax
private final PebbleCache<CacheKey,Object>	tagCache
private final PebbleCache<Object, PebbleTemplate>	templateCache

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PebbleEngine(Loader<?> loader, Syntax syntax, boolean strictVariables, Locale defaultLocale, int maxRenderedSize, PebbleCache<CacheKey,Object> tagCache, PebbleCache<Object, PebbleTemplate> templateCache, ExecutorService executorService, ExtensionRegistry extensionRegistry, ParserOptions parserOptions, EvaluationOptions evaluationOptions)	Constructor for the Pebble Engine given an instantiated Loader.

Method Summary

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Returns the default locale
EvaluationOptions	getEvaluationOptions()
ExecutorService	getExecutorService()	Returns the executor service
ExtensionRegistry	getExtensionRegistry()	Returns the extension registry.
PebbleTemplate	getLiteralTemplate(String templateName)	Loads, parses, and compiles a template using a StringLoader into an instance of PebbleTemplate and returns this instance.
Loader<?>	getLoader()	Returns the loader
int	getMaxRenderedSize()	Returns the max rendered size.
private PebbleTemplate	getPebbleTemplate(String templateName, Loader loader, Object cacheKey)
Syntax	getSyntax()	Returns the syntax which is used by this PebbleEngine.
PebbleCache<CacheKey,Object>	getTagCache()	Returns the tag cache
PebbleTemplate	getTemplate(String templateName)	Loads, parses, and compiles a template into an instance of PebbleTemplate and returns this instance.
private PebbleTemplate	getTemplate(String templateName, Loader loader)
PebbleCache<Object, PebbleTemplate>	getTemplateCache()	Returns the template cache
boolean	isStrictVariables()	Returns the strict variables setting

Methods inherited from class Object

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

Field Details

logger

private final org.slf4j.Logger logger

loader

private final Loader<?> loader

syntax

private final Syntax syntax

strictVariables

private final boolean strictVariables

defaultLocale

private final Locale defaultLocale

maxRenderedSize

private final int maxRenderedSize

tagCache

private final PebbleCache<CacheKey,Object> tagCache

executorService

private final ExecutorService executorService

templateCache

private final PebbleCache<Object, PebbleTemplate> templateCache

extensionRegistry

private final ExtensionRegistry extensionRegistry

parserOptions

private final ParserOptions parserOptions

evaluationOptions

private final EvaluationOptions evaluationOptions

Constructor Details

PebbleEngine

private PebbleEngine(Loader<?> loader,
 Syntax syntax,
 boolean strictVariables,
 Locale defaultLocale,
 int maxRenderedSize,
 PebbleCache<CacheKey,Object> tagCache,
 PebbleCache<Object, PebbleTemplate> templateCache,
 ExecutorService executorService,
 ExtensionRegistry extensionRegistry,
 ParserOptions parserOptions,
 EvaluationOptions evaluationOptions)

Constructor for the Pebble Engine given an instantiated Loader. This method does only load those userProvidedExtensions listed here.

Parameters:

loader - The template loader for this engine

syntax - the syntax to use for parsing the templates.

Method Details

getTemplate

public PebbleTemplate getTemplate(String templateName)

Loads, parses, and compiles a template into an instance of PebbleTemplate and returns this instance.

Parameters:

templateName - The name of the template

Returns:

PebbleTemplate The compiled version of the template

getLiteralTemplate

public PebbleTemplate getLiteralTemplate(String templateName)

Loads, parses, and compiles a template using a StringLoader into an instance of PebbleTemplate and returns this instance.

Parameters:

templateName - The name of the template

Returns:

PebbleTemplate The compiled version of the template

getTemplate

private PebbleTemplate getTemplate(String templateName,
 Loader loader)

getPebbleTemplate

private PebbleTemplate getPebbleTemplate(String templateName,
 Loader loader,
 Object cacheKey)

getLoader

public Loader<?> getLoader()

Returns the loader

Returns:

The loader

getTemplateCache

public PebbleCache<Object, PebbleTemplate> getTemplateCache()

Returns the template cache

Returns:

The template cache

isStrictVariables

public boolean isStrictVariables()

Returns the strict variables setting

Returns:

The strict variables setting

getDefaultLocale

public Locale getDefaultLocale()

Returns the default locale

Returns:

The default locale

getMaxRenderedSize

public int getMaxRenderedSize()

Returns the max rendered size.

Returns:

The max rendered size.

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service

Returns:

The executor service

getSyntax

public Syntax getSyntax()

Returns the syntax which is used by this PebbleEngine.

Returns:

the syntax used by the PebbleEngine.

getExtensionRegistry

public ExtensionRegistry getExtensionRegistry()

Returns the extension registry.

Returns:

The extension registry

getTagCache

public PebbleCache<CacheKey,Object> getTagCache()

Returns the tag cache

Returns:

The tag cache

getEvaluationOptions

public EvaluationOptions getEvaluationOptions()