java.lang.Object
- com.hubspot.jinjava.interpret.JinjavaInterpreter

All Implemented Interfaces:: PyWrapper, PyishSerializable

public class JinjavaInterpreter
extends Object
implements PyishSerializable

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class JinjavaInterpreter.InterpreterScopeClosable

Field Summary
- Fields inherited from interface com.hubspot.jinjava.objects.serialization.PyishSerializable
  SELF_WRITER

Constructor Summary

Constructors
Constructor	Description
`JinjavaInterpreter(JinjavaInterpreter orig)`
`JinjavaInterpreter(Jinjava application, Context context, JinjavaConfig renderConfig)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addAllChildErrors(String childTemplateName, Collection<TemplateError> childErrors)`
`void`	`addAllErrors(Collection<TemplateError> other)`	Deprecated.
`void`	`addBlock(String name, BlockInfo blockInfo)`
`void`	`addError(TemplateError templateError)`
`void`	`addExtendParentRoot(Node root)`
`<T extends Appendable & CharSequence> T`	`appendPyishString(T appendable)`	Allows for a class to append the custom string representation in Jinjava.
`static void`	`checkOutputSize(String string)`
`void`	`endRender(String name)`
`void`	`endRender(String name, Map<String,Object> data)`
`JinjavaInterpreter.InterpreterScopeClosable`	`enterNonStackingScope()`
`JinjavaInterpreter.InterpreterScopeClosable`	`enterScope()`	Creates a new variable scope, extending from the current scope.
`JinjavaInterpreter.InterpreterScopeClosable`	`enterScope(Map<Context.Library,Set<String>> disabled)`
`String`	`getAsString(Object object)`
`JinjavaConfig`	`getConfig()`
`JinjavaConfig`	`getConfiguration()`	Deprecated. use {`getConfig()`}
`Context`	`getContext()`
`static JinjavaInterpreter`	`getCurrent()`
`BlockInfo`	`getCurrentBlock()`
`static Optional<JinjavaInterpreter>`	`getCurrentMaybe()`
`List<TemplateError>`	`getErrors()`
`List<TemplateError>`	`getErrorsCopy()`
`Optional<TemplateError>`	`getLastError()`
`int`	`getLineNumber()`
`int`	`getPosition()`
`Random`	`getRandom()`
`String`	`getResource(String resource)`
`Map<String,RevertibleObject>`	`getRevertibleObjects()`
`int`	`getScopeDepth()`
`boolean`	`isValidationMode()`
`void`	`leaveScope()`
`Node`	`parse(String template)`
`static void`	`popCurrent()`
`static void`	`pushCurrent(JinjavaInterpreter interpreter)`
`void`	`removeLastError()`
`String`	`render(Node root)`	Render the given root node, processing extend parents.
`String`	`render(Node root, boolean processExtendRoots)`	Render the given root node using this interpreter's current context
`String`	`render(String template)`	Parse the given string into a root Node, and then renders it processing extend parents.
`String`	`renderFlat(String template)`	Parse the given string into a root Node, and then render it without processing any extend parents.
`Object`	`resolveELExpression(String expression, int lineNumber)`	Resolve expression against current context.
`Object`	`resolveELExpression(String expression, int lineNumber, int position)`	Resolve expression against current context.
`Object`	`resolveELExpressionSilently(String expression)`	Resolve expression against current context, but does not add the expression to the set of resolved expressions.
`Object`	`resolveObject(String variable, int lineNumber)`
`Object`	`resolveObject(String variable, int lineNumber, int startPosition)`	Resolve a variable into an object value.
`Object`	`resolveProperty(Object object, String propertyName)`	Resolve property of bean.
`Object`	`resolveProperty(Object object, List<String> propertyNames)`	Resolve property of bean.
`String`	`resolveResourceLocation(String location)`
`String`	`resolveString(String variable, int lineNumber)`
`String`	`resolveString(String variable, int lineNumber, int startPosition)`	Resolve a variable into a string value.
`Object`	`retraceVariable(String variable, int lineNumber)`
`Object`	`retraceVariable(String variable, int lineNumber, int startPosition)`	Resolve a variable from the interpreter context, returning null if not found.
`void`	`setLineNumber(int lineNumber)`
`void`	`setPosition(int position)`
`void`	`startRender(String name)`
`Object`	`wrap(Object object)`	Wrap an object in it's PyIsh equivalent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hubspot.jinjava.objects.serialization.PyishSerializable
writePyishSelf

- Constructor Detail
  - JinjavaInterpreter
```
public JinjavaInterpreter(Jinjava application,
                          Context context,
                          JinjavaConfig renderConfig)
```
  - JinjavaInterpreter
```
public JinjavaInterpreter(JinjavaInterpreter orig)
```
- Method Detail
  - checkOutputSize
```
public static void checkOutputSize(String string)
```
  - getConfiguration
```
@Deprecated
public JinjavaConfig getConfiguration()
```
    Deprecated.
    use {getConfig()}
  - addExtendParentRoot
```
public void addExtendParentRoot(Node root)
```
  - addBlock
```
public void addBlock(String name,
                     BlockInfo blockInfo)
```
  - enterScope
```
public JinjavaInterpreter.InterpreterScopeClosable enterScope()
```
    Creates a new variable scope, extending from the current scope. Allows you to create a nested contextual scope which can override variables from higher levels.
    Should be used in a try/finally context, similar to lock-use patterns:
    interpreter.enterScope(); try (interpreter.enterScope()) { // ... }
  - enterScope
```
public JinjavaInterpreter.InterpreterScopeClosable enterScope(Map<Context.Library,Set<String>> disabled)
```
  - enterNonStackingScope
```
public JinjavaInterpreter.InterpreterScopeClosable enterNonStackingScope()
```
  - leaveScope
```
public void leaveScope()
```
  - getRandom
```
public Random getRandom()
```
  - isValidationMode
```
public boolean isValidationMode()
```
  - getRevertibleObjects
```
public Map<String,RevertibleObject> getRevertibleObjects()
```
  - parse
```
public Node parse(String template)
```
  - renderFlat
```
public String renderFlat(String template)
```
    Parse the given string into a root Node, and then render it without processing any extend parents. This method should be used when the template is known to not have any extends or block tags.
    
    Parameters:
    
    template - string to parse
    
    Returns:
    
    rendered result
  - render
```
public String render(String template)
```
    Parse the given string into a root Node, and then renders it processing extend parents.
    
    Parameters:
    
    template - string to parse
    
    Returns:
    
    rendered result
  - render
```
public String render(Node root)
```
    Render the given root node, processing extend parents. Equivalent to render(root, true)
    
    Parameters:
    
    root - node to render
    
    Returns:
    
    rendered result
  - render
```
public String render(Node root,
                     boolean processExtendRoots)
```
    Render the given root node using this interpreter's current context
    
    Parameters:
    
    root - node to render
    
    processExtendRoots - if true, also render all extend parents
    
    Returns:
    
    rendered result
  - retraceVariable
```
public Object retraceVariable(String variable,
                              int lineNumber,
                              int startPosition)
```
    Resolve a variable from the interpreter context, returning null if not found. This method updates the template error accumulators when a variable is not found.
    
    Parameters:
    
    variable - name of variable in context
    
    lineNumber - current line number, for error reporting
    
    startPosition - current line position, for error reporting
    
    Returns:
    
    resolved value for variable
  - retraceVariable
```
public Object retraceVariable(String variable,
                              int lineNumber)
```
  - resolveObject
```
public Object resolveObject(String variable,
                            int lineNumber,
                            int startPosition)
```
    Resolve a variable into an object value. If given a string literal (e.g. 'foo' or "foo"), this method returns the literal unquoted. If the variable is undefined in the context, this method returns the given variable string.
    
    Parameters:
    
    variable - name of variable in context
    
    lineNumber - current line number, for error reporting
    
    startPosition - current line position, for error reporting
    
    Returns:
    
    resolved value for variable
  - resolveObject
```
public Object resolveObject(String variable,
                            int lineNumber)
```
  - resolveString
```
public String resolveString(String variable,
                            int lineNumber,
                            int startPosition)
```
    Resolve a variable into a string value. If given a string literal (e.g. 'foo' or "foo"), this method returns the literal unquoted. If the variable is undefined in the context, this method returns the given variable string.
    
    Parameters:
    
    variable - name of variable in context
    
    lineNumber - current line number, for error reporting
    
    startPosition - current line position, for error reporting
    
    Returns:
    
    resolved value for variable
  - getAsString
```
public String getAsString(Object object)
```
  - resolveString
```
public String resolveString(String variable,
                            int lineNumber)
```
  - getContext
```
public Context getContext()
```
  - resolveResourceLocation
```
public String resolveResourceLocation(String location)
```
  - getResource
```
public String getResource(String resource)
                   throws IOException
```
    Throws:
    
    IOException
  - getConfig
```
public JinjavaConfig getConfig()
```
  - resolveELExpressionSilently
```
public Object resolveELExpressionSilently(String expression)
```
    Resolve expression against current context, but does not add the expression to the set of resolved expressions.
    
    Parameters:
    
    expression - Jinja expression.
    
    Returns:
    
    Value of expression.
  - resolveELExpression
```
public Object resolveELExpression(String expression,
                                  int lineNumber)
```
    Resolve expression against current context.
    
    Parameters:
    
    expression - Jinja expression.
    
    lineNumber - Line number of expression.
    
    Returns:
    
    Value of expression.
  - resolveELExpression
```
public Object resolveELExpression(String expression,
                                  int lineNumber,
                                  int position)
```
    Resolve expression against current context. Also set the interpreter's position, useful for nodes that resolve multiple expressions such as a node using an IfTag and ElseTags.
    
    Parameters:
    
    expression - Jinja expression.
    
    lineNumber - Line number of expression.
    
    position - Start position of expression.
    
    Returns:
    
    Value of expression.
  - resolveProperty
```
public Object resolveProperty(Object object,
                              String propertyName)
```
    Resolve property of bean.
    
    Parameters:
    
    object - Bean.
    
    propertyName - Name of property to resolve.
    
    Returns:
    
    Value of property.
  - resolveProperty
```
public Object resolveProperty(Object object,
                              List<String> propertyNames)
```
    Resolve property of bean.
    
    Parameters:
    
    object - Bean.
    
    propertyNames - Names of properties to resolve recursively.
    
    Returns:
    
    Value of property.
  - wrap
```
public Object wrap(Object object)
```
    Wrap an object in it's PyIsh equivalent
    
    Parameters:
    
    object - Bean.
    
    Returns:
    
    Wrapped bean.
  - getLineNumber
```
public int getLineNumber()
```
  - setLineNumber
```
public void setLineNumber(int lineNumber)
```
  - getPosition
```
public int getPosition()
```
  - setPosition
```
public void setPosition(int position)
```
  - getCurrentBlock
```
public BlockInfo getCurrentBlock()
```
  - addError
```
public void addError(TemplateError templateError)
```
  - removeLastError
```
public void removeLastError()
```
  - getLastError
```
public Optional<TemplateError> getLastError()
```
  - getScopeDepth
```
public int getScopeDepth()
```
  - addAllErrors
```
@Deprecated
public void addAllErrors(Collection<TemplateError> other)
```
    Deprecated.
    
    Use addAllChildErrors(String, Collection) instead to fix error line numbers
  - addAllChildErrors
```
public void addAllChildErrors(String childTemplateName,
                              Collection<TemplateError> childErrors)
```
  - getErrors
```
public List<TemplateError> getErrors()
```
  - getErrorsCopy
```
public List<TemplateError> getErrorsCopy()
```
  - getCurrent
```
public static JinjavaInterpreter getCurrent()
```
  - getCurrentMaybe
```
public static Optional<JinjavaInterpreter> getCurrentMaybe()
```
  - pushCurrent
```
public static void pushCurrent(JinjavaInterpreter interpreter)
```
  - popCurrent
```
public static void popCurrent()
```
  - startRender
```
public void startRender(String name)
```
  - endRender
```
public void endRender(String name)
```
  - endRender
```
public void endRender(String name,
                      Map<String,Object> data)
```
  - appendPyishString
```
public <T extends Appendable & CharSequence> T appendPyishString(T appendable)
                                                          throws IOException
```
    Description copied from interface: PyishSerializable
    
    Allows for a class to append the custom string representation in Jinjava. This method will be used by PyishSerializable.writePyishSelf(JsonGenerator, SerializerProvider) to specify what will be written to the json generator.
    
    Specified by:
    
    appendPyishString in interface PyishSerializable
    
    Parameters:
    
    appendable - Appendable to append the pyish string representation to.
    
    Returns:
    
    The same appendable with an appended result
    
    Throws:
    
    IOException

Class JinjavaInterpreter

Nested Class Summary

Field Summary

Fields inherited from interface com.hubspot.jinjava.objects.serialization.PyishSerializable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.hubspot.jinjava.objects.serialization.PyishSerializable

Constructor Detail

JinjavaInterpreter

JinjavaInterpreter

Method Detail

checkOutputSize

getConfiguration

addExtendParentRoot

addBlock

enterScope

enterScope

enterNonStackingScope

leaveScope

getRandom

isValidationMode

getRevertibleObjects

parse

renderFlat

render

render

render

retraceVariable

retraceVariable

resolveObject

resolveObject

resolveString

getAsString

resolveString

getContext

resolveResourceLocation

getResource

getConfig

resolveELExpressionSilently

resolveELExpression

resolveELExpression

resolveProperty

resolveProperty

wrap

getLineNumber

setLineNumber

getPosition

setPosition

getCurrentBlock

addError

removeLastError

getLastError

getScopeDepth

addAllErrors

addAllChildErrors

getErrors

getErrorsCopy

getCurrent

getCurrentMaybe

pushCurrent

popCurrent

startRender

endRender

endRender

appendPyishString