Package com.hubspot.jinjava.interpret

Class Context

java.lang.Object

com.hubspot.jinjava.util.ScopeMap<String,Object>

com.hubspot.jinjava.interpret.Context

All Implemented Interfaces:

Map<String,Object>

public class Context
extends ScopeMap<String,Object>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Context.Library
static class	Context.TemporaryValueClosable<T>

Nested classes/interfaces inherited from class com.hubspot.jinjava.util.ScopeMap

ScopeMap.ScopeMapEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFERRED_IMPORT_RESOURCE_PATH_KEY
static String	GLOBAL_MACROS_SCOPE_KEY
static String	IMPORT_RESOURCE_ALIAS_KEY
static String	IMPORT_RESOURCE_PATH_KEY

Constructor Summary

Constructors

Constructor	Description
Context()
Context(Context parent)
Context(Context parent, Map<String,?> bindings)
Context(Context parent, Map<String,?> bindings, Map<Context.Library,Set<String>> disabled)
Context(Context parent, Map<String,?> bindings, Map<Context.Library,Set<String>> disabled, boolean makeNewCallStacks)

Method Summary

Modifier and Type	Method	Description
void	addDependencies(com.google.common.collect.SetMultimap<String,String> dependencies)
void	addDependency(String type, String identification)
void	addGlobalMacro(MacroFunction macro)
void	addResolvedExpression(String expression)
void	addResolvedFrom(Context context)	Take all resolved strings from a context object and apply them to this context.
void	addResolvedFunction(String function)
void	addResolvedValue(String value)
void	checkNumberOfDeferredTokens()
boolean	doesRenderStackContain(String template)
Collection<ExpTest>	getAllExpTests()
Collection<Filter>	getAllFilters()
Collection<ELFunctionDefinition>	getAllFunctions()
Collection<Tag>	getAllTags()
Map<String,Object>	getCombinedScope()
Node	getCurrentNode()
CallStack	getCurrentPathStack()
Set<Node>	getDeferredNodes()
Set<DeferredToken>	getDeferredTokens()
com.google.common.collect.SetMultimap<String,String>	getDependencies()
DynamicVariableResolver	getDynamicVariableResolver()
ExpressionStrategy	getExpressionStrategy()
ExpTest	getExpTest(String name)
CallStack	getExtendPathStack()
Filter	getFilter(String name)
ELFunctionDefinition	getFunction(String name)
MacroFunction	getGlobalMacro(String identifier)
Map<String,MacroFunction>	getGlobalMacros()
CallStack	getImportPathStack()
Optional<String>	getImportResourceAlias()
CallStack	getIncludePathStack()
Optional<MacroFunction>	getLocalMacro(String fullName)
CallStack	getMacroStack()
Set<String>	getMetaContextVariables()
Context	getParent()
Context	getPenultimateParent()
int	getRenderDepth()
Set<String>	getResolvedExpressions()
Set<String>	getResolvedFunctions()
Set<String>	getResolvedValues()
Map<String,Object>	getSessionBindings()
List<? extends Node>	getSuperBlock()
Tag	getTag(String name)
boolean	getThrowInterpreterErrors()
void	handleDeferredNode(Node node)
void	handleDeferredToken(DeferredToken deferredToken)
boolean	isAutoEscape()
boolean	isDeferLargeObjects()
boolean	isDeferredExecutionMode()
boolean	isFunctionDisabled(String name)
boolean	isGlobalMacro(String identifier)
boolean	isInForLoop()
boolean	isPartialMacroEvaluation()
boolean	isUnwrapRawOverride()
boolean	isValidationMode()
void	popFromStack()
String	popRenderStack()
void	pushFromStack(String path, int lineNumber, int startPosition)
void	pushRenderStack(String template)
void	registerClasses(Class<? extends Importable>... classes)
void	registerExpTest(ExpTest t)
void	registerFilter(Filter f)
void	registerFunction(ELFunctionDefinition f)
void	registerTag(Tag t)
void	removeDeferredTokens(Collection<DeferredToken> toRemove)
void	removeSuperBlock()
void	reset()
void	setAutoEscape(Boolean autoEscape)
void	setCurrentNode(Node currentNode)
Context	setDeferLargeObjects(boolean deferLargeObjects)
Context	setDeferredExecutionMode(boolean deferredExecutionMode)
void	setDynamicVariableResolver(DynamicVariableResolver dynamicVariableResolver)
void	setExpressionStrategy(ExpressionStrategy expressionStrategy)
void	setPartialMacroEvaluation(boolean partialMacroEvaluation)
void	setRenderDepth(int renderDepth)
void	setSuperBlock(List<? extends Node> superBlock)
void	setThrowInterpreterErrors(boolean throwInterpreterErrors)
void	setUnwrapRawOverride(boolean unwrapRawOverride)
Context	setValidationMode(boolean validationMode)
boolean	wasExpressionResolved(String expression)
boolean	wasValueResolved(String value)
Context.TemporaryValueClosable<Boolean>	withDeferLargeObjects(boolean deferLargeObjects)
Context.TemporaryValueClosable<Boolean>	withPartialMacroEvaluation()
Context.TemporaryValueClosable<Boolean>	withPartialMacroEvaluation(boolean partialMacroEvaluation)
Context.TemporaryValueClosable<Boolean>	withUnwrapRawOverride()

Methods inherited from class com.hubspot.jinjava.util.ScopeMap

clear, containsKey, containsValue, entrySet, get, get, getScope, isEmpty, keySet, put, putAll, remove, replace, replace, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replaceAll

Field Detail

GLOBAL_MACROS_SCOPE_KEY

public static final String GLOBAL_MACROS_SCOPE_KEY

See Also:

Constant Field Values

IMPORT_RESOURCE_PATH_KEY

public static final String IMPORT_RESOURCE_PATH_KEY

See Also:

Constant Field Values

DEFERRED_IMPORT_RESOURCE_PATH_KEY

public static final String DEFERRED_IMPORT_RESOURCE_PATH_KEY

See Also:

Constant Field Values

IMPORT_RESOURCE_ALIAS_KEY

public static final String IMPORT_RESOURCE_ALIAS_KEY

See Also:

Constant Field Values

Constructor Detail

Context

public Context()

Context

public Context(Context parent)

Context

public Context(Context parent,
               Map<String,?> bindings)

Context

public Context(Context parent,
               Map<String,?> bindings,
               Map<Context.Library,Set<String>> disabled)

Context

public Context(Context parent,
               Map<String,?> bindings,
               Map<Context.Library,Set<String>> disabled,
               boolean makeNewCallStacks)

Method Detail

isValidationMode

public boolean isValidationMode()

setValidationMode

public Context setValidationMode(boolean validationMode)

reset

public void reset()

getParent

public Context getParent()

Overrides:

getParent in class ScopeMap<String,Object>

getSessionBindings

public Map<String,Object> getSessionBindings()

getGlobalMacros

public Map<String,MacroFunction> getGlobalMacros()

addGlobalMacro

public void addGlobalMacro(MacroFunction macro)

getGlobalMacro

public MacroFunction getGlobalMacro(String identifier)

isGlobalMacro

public boolean isGlobalMacro(String identifier)

getLocalMacro

public Optional<MacroFunction> getLocalMacro(String fullName)

isAutoEscape

public boolean isAutoEscape()

setAutoEscape

public void setAutoEscape(Boolean autoEscape)

addResolvedExpression

public void addResolvedExpression(String expression)

getResolvedExpressions

public Set<String> getResolvedExpressions()

wasExpressionResolved

public boolean wasExpressionResolved(String expression)

addResolvedValue

public void addResolvedValue(String value)

getResolvedValues

public Set<String> getResolvedValues()

wasValueResolved

public boolean wasValueResolved(String value)

getResolvedFunctions

public Set<String> getResolvedFunctions()

addResolvedFunction

public void addResolvedFunction(String function)

getMetaContextVariables

public Set<String> getMetaContextVariables()

handleDeferredNode

public void handleDeferredNode(Node node)

getDeferredNodes

public Set<Node> getDeferredNodes()

checkNumberOfDeferredTokens

public void checkNumberOfDeferredTokens()

handleDeferredToken

public void handleDeferredToken(DeferredToken deferredToken)

removeDeferredTokens

public void removeDeferredTokens(Collection<DeferredToken> toRemove)

getDeferredTokens

public Set<DeferredToken> getDeferredTokens()

getCombinedScope

public Map<String,Object> getCombinedScope()

getPenultimateParent

public Context getPenultimateParent()

getSuperBlock

public List<? extends Node> getSuperBlock()

setSuperBlock

public void setSuperBlock(List<? extends Node> superBlock)

removeSuperBlock

public void removeSuperBlock()

addResolvedFrom

public void addResolvedFrom(Context context)

Take all resolved strings from a context object and apply them to this context. Useful for passing resolved values up a tag hierarchy.

Parameters:

context - - context object to apply resolved values from.

registerClasses

@SafeVarargs
public final void registerClasses(Class<? extends Importable>... classes)

getAllExpTests

public Collection<ExpTest> getAllExpTests()

getExpTest

public ExpTest getExpTest(String name)

registerExpTest

public void registerExpTest(ExpTest t)

getAllFilters

public Collection<Filter> getAllFilters()

getFilter

public Filter getFilter(String name)

registerFilter

public void registerFilter(Filter f)

isFunctionDisabled

public boolean isFunctionDisabled(String name)

getFunction

public ELFunctionDefinition getFunction(String name)

getAllFunctions

public Collection<ELFunctionDefinition> getAllFunctions()

registerFunction

public void registerFunction(ELFunctionDefinition f)

getAllTags

public Collection<Tag> getAllTags()

getTag

public Tag getTag(String name)

registerTag

public void registerTag(Tag t)

getDynamicVariableResolver

public DynamicVariableResolver getDynamicVariableResolver()

setDynamicVariableResolver

public void setDynamicVariableResolver(DynamicVariableResolver dynamicVariableResolver)

getExpressionStrategy

public ExpressionStrategy getExpressionStrategy()

setExpressionStrategy

public void setExpressionStrategy(ExpressionStrategy expressionStrategy)

getImportResourceAlias

public Optional<String> getImportResourceAlias()

getExtendPathStack

public CallStack getExtendPathStack()

getImportPathStack

public CallStack getImportPathStack()

getIncludePathStack

public CallStack getIncludePathStack()

getMacroStack

public CallStack getMacroStack()

getCurrentPathStack

public CallStack getCurrentPathStack()

pushFromStack

public void pushFromStack(String path,
                          int lineNumber,
                          int startPosition)

popFromStack

public void popFromStack()

getRenderDepth

public int getRenderDepth()

setRenderDepth

public void setRenderDepth(int renderDepth)

pushRenderStack

public void pushRenderStack(String template)

popRenderStack

public String popRenderStack()

doesRenderStackContain

public boolean doesRenderStackContain(String template)

addDependency

public void addDependency(String type,
                          String identification)

addDependencies

public void addDependencies(com.google.common.collect.SetMultimap<String,String> dependencies)

getDependencies

public com.google.common.collect.SetMultimap<String,String> getDependencies()

isDeferredExecutionMode

public boolean isDeferredExecutionMode()

setDeferredExecutionMode

public Context setDeferredExecutionMode(boolean deferredExecutionMode)

isDeferLargeObjects

public boolean isDeferLargeObjects()

setDeferLargeObjects

public Context setDeferLargeObjects(boolean deferLargeObjects)

withDeferLargeObjects

public Context.TemporaryValueClosable<Boolean> withDeferLargeObjects(boolean deferLargeObjects)

getThrowInterpreterErrors

public boolean getThrowInterpreterErrors()

setThrowInterpreterErrors

public void setThrowInterpreterErrors(boolean throwInterpreterErrors)

isPartialMacroEvaluation

public boolean isPartialMacroEvaluation()

setPartialMacroEvaluation

public void setPartialMacroEvaluation(boolean partialMacroEvaluation)

withPartialMacroEvaluation

public Context.TemporaryValueClosable<Boolean> withPartialMacroEvaluation()

withPartialMacroEvaluation

public Context.TemporaryValueClosable<Boolean> withPartialMacroEvaluation(boolean partialMacroEvaluation)

isUnwrapRawOverride

public boolean isUnwrapRawOverride()

setUnwrapRawOverride

public void setUnwrapRawOverride(boolean unwrapRawOverride)

withUnwrapRawOverride

public Context.TemporaryValueClosable<Boolean> withUnwrapRawOverride()

getCurrentNode

public Node getCurrentNode()

setCurrentNode

public void setCurrentNode(Node currentNode)

isInForLoop

public boolean isInForLoop()