com.mitchellbosecke.pebble.template

Class EvaluationContext

java.lang.Object

com.mitchellbosecke.pebble.template.EvaluationContext

public class EvaluationContext
extends Object

An evaluation context will store all stateful data that is necessary for the evaluation of a template. Passing the entire state around will assist with thread safety.

Author:

Mitchell

Constructor Summary

Constructors

Constructor and Description

EvaluationContext(PebbleTemplateImpl self, boolean strictVariables, Locale locale, ExtensionRegistry extensionRegistry, com.google.common.cache.Cache<CacheKey,Object> tagCache, ExecutorService executorService, List<PebbleTemplateImpl> importedTemplates, Map<String,PebbleTemplateImpl> namedImportedTemplates, ScopeChain scopeChain, Hierarchy hierarchy, EvaluationOptions evaluationOptions) Constructor used to provide all final variables.

Method Summary

Modifier and Type	Method and Description
void	addNamedImportedTemplates(String alias, PebbleTemplateImpl template)
EvaluationOptions	getEvaluationOptions() Returns the evaluation options.
ExecutorService	getExecutorService() Returns the executor service if exists or null
ExtensionRegistry	getExtensionRegistry() Returns the extension registry used to access all of the tests/filters/functions
Hierarchy	getHierarchy() Returns the data structure representing the entire hierarchy of the template currently being evaluated.
List<PebbleTemplateImpl>	getImportedTemplates() Returns a list of imported templates.
Locale	getLocale() Returns the locale
PebbleTemplateImpl	getNamedImportedTemplate(String alias) Returns the named imported template.
ScopeChain	getScopeChain() Returns the scope chain data structure that allows variables to be added/removed from the current scope and retrieved from the nearest visible scopes.
com.google.common.cache.Cache<CacheKey,Object>	getTagCache() Returns the cache used for the "cache" tag
boolean	isStrictVariables() Returns whether or not this template is being evaluated in "strict templates" mode
EvaluationContext	shallowCopyWithoutInheritanceChain(PebbleTemplateImpl self) Makes an exact copy of the evaluation context EXCEPT for the inheritance chain.
EvaluationContext	threadSafeCopy(PebbleTemplateImpl self) Makes a "snapshot" of the evaluation context.

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluationContext

public EvaluationContext(PebbleTemplateImpl self,
                         boolean strictVariables,
                         Locale locale,
                         ExtensionRegistry extensionRegistry,
                         com.google.common.cache.Cache<CacheKey,Object> tagCache,
                         ExecutorService executorService,
                         List<PebbleTemplateImpl> importedTemplates,
                         Map<String,PebbleTemplateImpl> namedImportedTemplates,
                         ScopeChain scopeChain,
                         Hierarchy hierarchy,
                         EvaluationOptions evaluationOptions)

Constructor used to provide all final variables.

Parameters:

self - The template implementation

strictVariables - Whether strict variables is to be used

locale - The locale of the template

extensionRegistry - The extension registry

executorService - The optional executor service

scopeChain - The scope chain

hierarchy - The inheritance chain

tagCache - The cache used by the "cache" tag

Method Detail

shallowCopyWithoutInheritanceChain

public EvaluationContext shallowCopyWithoutInheritanceChain(PebbleTemplateImpl self)

Makes an exact copy of the evaluation context EXCEPT for the inheritance chain. This is necessary for the "include" tag.

Parameters:

self - The template implementation

Returns:

A copy of the evaluation context

threadSafeCopy

public EvaluationContext threadSafeCopy(PebbleTemplateImpl self)

Makes a "snapshot" of the evaluation context. The scopeChain object will be a deep copy and the imported templates will be a new list. This is used for the "parallel" tag.

Parameters:

self - The template implementation

Returns:

A copy of the evaluation context

isStrictVariables

public boolean isStrictVariables()

Returns whether or not this template is being evaluated in "strict templates" mode

Returns:

Whether or not this template is being evaluated in "strict tempaltes" mode.

getLocale

public Locale getLocale()

Returns the locale

Returns:

The current locale

getExtensionRegistry

public ExtensionRegistry getExtensionRegistry()

Returns the extension registry used to access all of the tests/filters/functions

Returns:

The extension registry

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service if exists or null

Returns:

The executor service if exists, or null

getImportedTemplates

public List<PebbleTemplateImpl> getImportedTemplates()

Returns a list of imported templates.

Returns:

A list of imported templates.

getNamedImportedTemplate

public PebbleTemplateImpl getNamedImportedTemplate(String alias)

Returns the named imported template.

Returns:

the named imported template.

addNamedImportedTemplates

public void addNamedImportedTemplates(String alias,
                                      PebbleTemplateImpl template)

getTagCache

public com.google.common.cache.Cache<CacheKey,Object> getTagCache()

Returns the cache used for the "cache" tag

Returns:

The cache used for the "cache" tag

getScopeChain

public ScopeChain getScopeChain()

Returns the scope chain data structure that allows variables to be added/removed from the current scope and retrieved from the nearest visible scopes.

Returns:

The scope chain.

getHierarchy

public Hierarchy getHierarchy()

Returns the data structure representing the entire hierarchy of the template currently being evaluated.

Returns:

The inheritance chain

getEvaluationOptions

public EvaluationOptions getEvaluationOptions()

Returns the evaluation options.

Returns:

the evaluation options