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, Map<String,Filter> filters, Map<String,Test> tests, Map<String,Function> functions, ExecutorService executorService, ScopeChain scopeChain, InheritanceChain inheritanceChain) Constructor used to provide all final variables.

Method Summary

Modifier and Type	Method and Description
void	addImportedTemplate(PebbleTemplateImpl template)
void	ascendInheritanceChain()
boolean	currentScopeContainsVariable(String variableName)
EvaluationContext	deepCopy(PebbleTemplateImpl self) Makes an exact copy of the evaluation context except the "scopeChain" object will be a deep copy without reference to the original.
void	descendInheritanceChain()
Object	get(String key) Will look for a variable, traveling upwards through the scope chain until it is found.
PebbleTemplateImpl	getChildTemplate()
ExecutorService	getExecutorService()
Map<String,Filter>	getFilters()
Map<String,Function>	getFunctions()
List<PebbleTemplateImpl>	getImportedTemplates()
Locale	getLocale()
PebbleTemplateImpl	getParentTemplate()
Map<String,Test>	getTests()
boolean	isStrictVariables()
void	popScope()
void	pushLocalScope() Pushes a new scope that doesn't contain a reference to the current scope.
void	pushScope() Creates a new scope that contains a reference to the current scope.
void	pushScope(Map<String,Object> map)
void	put(String key, Object value) This method might be called DURING the evaluation of a template (ex.
void	setParent(PebbleTemplateImpl parent)
EvaluationContext	shallowCopyWithoutInheritanceChain(PebbleTemplateImpl self) Makes an exact copy of the evaluation context EXCEPT for the inheritance chain.

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,
                         Map<String,Filter> filters,
                         Map<String,Test> tests,
                         Map<String,Function> functions,
                         ExecutorService executorService,
                         ScopeChain scopeChain,
                         InheritanceChain inheritanceChain)

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

filters - Available filters

tests - Available tests

functions - Available functions

executorService - The optional executor service

scopeChain - The scope chain

inheritanceChain - The inheritance chain

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

deepCopy

public EvaluationContext deepCopy(PebbleTemplateImpl self)

Makes an exact copy of the evaluation context except the "scopeChain" object will be a deep copy without reference to the original. This is used for the "parallel" tag.

Parameters:

self - The template implementation

Returns:

A copy of the evaluation context

put

public void put(String key,
                Object value)

This method might be called DURING the evaluation of a template (ex. for node, set node, and macro node) and must be thread safe in case there are multiple threads evaluating the same template (via parallel tag).

Parameters:

key - Key

value - Value

get

public Object get(String key)

Will look for a variable, traveling upwards through the scope chain until it is found.

Parameters:

key - Key

Returns:

The object, if found

ascendInheritanceChain

public void ascendInheritanceChain()

descendInheritanceChain

public void descendInheritanceChain()

getParentTemplate

public PebbleTemplateImpl getParentTemplate()

getChildTemplate

public PebbleTemplateImpl getChildTemplate()

pushScope

public void pushScope()

Creates a new scope that contains a reference to the current scope.

pushScope

public void pushScope(Map<String,Object> map)

currentScopeContainsVariable

public boolean currentScopeContainsVariable(String variableName)

pushLocalScope

public void pushLocalScope()

Pushes a new scope that doesn't contain a reference to the current scope. This occurs for macros. Variable lookup will end at this scope.

popScope

public void popScope()

isStrictVariables

public boolean isStrictVariables()

getLocale

public Locale getLocale()

getTests

public Map<String,Test> getTests()

getFilters

public Map<String,Filter> getFilters()

getFunctions

public Map<String,Function> getFunctions()

getExecutorService

public ExecutorService getExecutorService()

addImportedTemplate

public void addImportedTemplate(PebbleTemplateImpl template)

getImportedTemplates

public List<PebbleTemplateImpl> getImportedTemplates()

setParent

public void setParent(PebbleTemplateImpl parent)