JinjavaInterpreter (jinjava 2.5.1 API)

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

public class JinjavaInterpreter
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class JinjavaInterpreter.InterpreterScopeClosable

Nested Classes
Modifier and Type	Class and Description
`class`	`JinjavaInterpreter.InterpreterScopeClosable`

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAllErrors(Collection<TemplateError> other)`
`void`	`addBlock(String name, LinkedList<? extends Node> value)`
`void`	`addError(TemplateError templateError)`
`void`	`addExtendParentRoot(Node root)`
`void`	`endRender(String name)`
`void`	`endRender(String name, Map<String,Object> data)`
`JinjavaInterpreter.InterpreterScopeClosable`	`enterScope()` Creates a new variable scope, extending from the current scope.
`JinjavaInterpreter.InterpreterScopeClosable`	`enterScope(Map<Context.Library,Set<String>> disabled)`
`JinjavaConfig`	`getConfig()`
`JinjavaConfig`	`getConfiguration()` Deprecated. use {`getConfig()`}
`Context`	`getContext()`
`static JinjavaInterpreter`	`getCurrent()`
`static Optional<JinjavaInterpreter>`	`getCurrentMaybe()`
`List<TemplateError>`	`getErrors()`
`List<TemplateError>`	`getErrorsCopy()`
`int`	`getLineNumber()`
`int`	`getPosition()`
`Random`	`getRandom()`
`String`	`getResource(String resource)`
`int`	`getScopeDepth()`
`boolean`	`isValidationMode()`
`void`	`leaveScope()`
`Node`	`parse(String template)`
`static void`	`popCurrent()`
`static void`	`pushCurrent(JinjavaInterpreter interpreter)`
`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`	`resolveObject(String variable, int lineNumber)`
`Object`	`resolveObject(String variable, int lineNumber, int startPosition)` Resolve a variable into an object value.
`Object`	`resolveProperty(Object object, List<String> propertyNames)` Resolve property of bean.
`Object`	`resolveProperty(Object object, String propertyName)` Resolve property of bean.
`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`	`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

- Constructor Detail
  - JinjavaInterpreter
```
public JinjavaInterpreter(Jinjava application,
                          Context context,
                          JinjavaConfig renderConfig)
```
  - JinjavaInterpreter
```
public JinjavaInterpreter(JinjavaInterpreter orig)
```
- Method Detail
  - getConfiguration
```
@Deprecated
public JinjavaConfig getConfiguration()
```
    Deprecated. use {getConfig()}
  - addExtendParentRoot
```
public void addExtendParentRoot(Node root)
```
  - addBlock
```
public void addBlock(String name,
                     LinkedList<? extends Node> value)
```
  - 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)
```
  - leaveScope
```
public void leaveScope()
```
  - getRandom
```
public Random getRandom()
```
  - isValidationMode
```
public boolean isValidationMode()
```
  - 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
  - resolveString
```
public String resolveString(String variable,
                            int lineNumber)
```
  - getContext
```
public Context getContext()
```
  - getResource
```
public String getResource(String resource)
                   throws IOException
```
    Throws:
    
    IOException
  - getConfig
```
public JinjavaConfig getConfig()
```
  - 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.
  - 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()
```
  - getPosition
```
public int getPosition()
```
  - addError
```
public void addError(TemplateError templateError)
```
  - getScopeDepth
```
public int getScopeDepth()
```
  - addAllErrors
```
public void addAllErrors(Collection<TemplateError> other)
```
  - 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)
```

Class JinjavaInterpreter

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JinjavaInterpreter

JinjavaInterpreter

Method Detail

getConfiguration

addExtendParentRoot

addBlock

enterScope

enterScope

leaveScope

getRandom

isValidationMode

parse

renderFlat

render

render

render

retraceVariable

retraceVariable

resolveObject

resolveObject

resolveString

resolveString

getContext

getResource

getConfig

resolveELExpression

resolveProperty

resolveProperty

wrap

getLineNumber

getPosition

addError

getScopeDepth

addAllErrors

getErrors

getErrorsCopy

getCurrent

getCurrentMaybe

pushCurrent

popCurrent

startRender

endRender

endRender