Package com.hubspot.jinjava.interpret

Class JinjavaInterpreter

    • Method Detail

      • addExtendParentRoot

        public void addExtendParentRoot​(Node root)

      • 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()) { // ... }

      • leaveScope

        public void leaveScope()

      • getRandom

        public Random getRandom()

      • isValidationMode

        public boolean isValidationMode()

      • 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)

      • 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()

      • setLineNumber

        public void setLineNumber​(int lineNumber)

      • getPosition

        public int getPosition()

      • setPosition

        public void setPosition​(int position)

      • addError

        public void addError​(TemplateError templateError)

      • getScopeDepth

        public int getScopeDepth()

      • popCurrent

        public static void popCurrent()

      • startRender

        public void startRender​(String name)

      • endRender

        public void endRender​(String name)

      • toPyishString

        public String toPyishString()
        Description copied from interface: PyishSerializable
        Allows for a class to specify a custom string representation in Jinjava. By default, this will get a json representation of the object, but this method can be overridden to provide a custom representation. This should use double quotes to wrap json keys/values.
        Specified by:
        toPyishString in interface PyishSerializable
        Returns:
        A pyish/json string representation of the object