Package org.thymeleaf.context

Class EngineContext

Object
org.thymeleaf.context.AbstractEngineContext
org.thymeleaf.context.EngineContext
All Implemented Interfaces:
IContext, IEngineContext, IExpressionContext, ITemplateContext
public class EngineContext extends AbstractEngineContext implements IEngineContext

Basic non-web implementation of the IEngineContext interface.

This is the context implementation that will be used by default for non-web processing. Note that this is an internal implementation, and that there is no reason for users' code to directly reference or use it instead of its implemented interfaces. Normally, the only reason to directly use this class would be as a part of some kind of integration/extension efforts (e.g. making Thymeleaf work in a specific type of non-Servlet-based application server).

This class is NOT thread-safe. Thread-safety is not a requirement for context implementations.

Since:
3.0.0
Author:
Daniel Fernández

  • Constructor Details

    • EngineContext

      public EngineContext(IEngineConfiguration configuration, TemplateData templateData, Map<String,Object> templateResolutionAttributes, Locale locale, Map<String,Object> variables)

      Creates a new instance of this IEngineContext implementation.

      Note that implementations of IEngineContext are not meant to be used in order to call the template engine (use implementations of IContext such as Context or WebContext instead). This is therefore mostly an internal implementation, and users should have no reason to ever call this constructor except in very specific integration/extension scenarios.

      Parameters:
      configuration - the configuration instance being used.
      templateData - the template data for the template to be processed.
      templateResolutionAttributes - the template resolution attributes.
      locale - the locale.
      variables - the context variables, probably coming from another IContext implementation.

  • Method Details

    • containsVariable

      public boolean containsVariable(String name)
      Description copied from interface: IContext

      Checks whether a specific variable is already contained in this context or not.

      Specified by:
      containsVariable in interface IContext
      Parameters:
      name - the name of the variable to be checked.
      Returns:
      true if the variable is already contained, false if not.

    • getVariable

      public Object getVariable(String key)
      Description copied from interface: IContext

      Retrieve a specific variable, by name.

      Specified by:
      getVariable in interface IContext
      Parameters:
      key - the name of the variable to be retrieved.
      Returns:
      the variable's value.

    • getVariableNames

      public Set<String> getVariableNames()
      Description copied from interface: IContext

      Get a list with all the names of variables contained at this context.

      Specified by:
      getVariableNames in interface IContext
      Returns:
      the variable names.

    • setVariable

      public void setVariable(String name, Object value)
      Description copied from interface: IEngineContext

      Sets a new variable into the context.

      Depending on the context level, determined by IEngineContext.increaseLevel() and IEngineContext.decreaseLevel(), the variable being set might be considered a local variable and thus disappear from context once the context level is decreased below the level the variable was created at.

      Specified by:
      setVariable in interface IEngineContext
      Parameters:
      name - the name of the variable.
      value - the value of the variable.

    • setVariables

      public void setVariables(Map<String,Object> variables)
      Description copied from interface: IEngineContext

      Sets several variables at a time into the context.

      Depending on the context level, determined by IEngineContext.increaseLevel() and IEngineContext.decreaseLevel(), the variables being set might be considered a local variables and thus disappear from context once the context level is decreased below the level the variable was created at.

      Specified by:
      setVariables in interface IEngineContext
      Parameters:
      variables - the variables to be set.

    • removeVariable

      public void removeVariable(String name)
      Description copied from interface: IEngineContext

      Removes a variable from the context.

      Depending on the context level, determined by IEngineContext.increaseLevel() and IEngineContext.decreaseLevel(), this removal might be considered local variable-related and thus cease to happen (i.e. the variable would be recovered) once the context level is decreased below the level the variable was created at.

      Specified by:
      removeVariable in interface IEngineContext
      Parameters:
      name - the name of the variable to be removed.

    • isVariableLocal

      public boolean isVariableLocal(String name)
      Description copied from interface: IEngineContext

      Checks whether a specific variable is local or not.

      This means checking if the context level at which the variable was defined was 0 or not.

      Specified by:
      isVariableLocal in interface IEngineContext
      Parameters:
      name - the name of the variable to be checked.
      Returns:
      true if the variable is local (level > 0), false if not (level == 0).

    • hasSelectionTarget

      public boolean hasSelectionTarget()
      Description copied from interface: ITemplateContext

      Returns whether the current template has set a selection target for the current point of execution or not.

      Selection targets are objects on which all *{...} expression will be executed (instead of on the root context). They are normally set by means of th:objects.

      Specified by:
      hasSelectionTarget in interface ITemplateContext
      Returns:
      true if there is a selection target, false if not.

    • getSelectionTarget

      public Object getSelectionTarget()
      Description copied from interface: ITemplateContext

      Returns the selection target set for the current point of execution (or null if there isn't any).

      Selection targets are objects on which all *{...} expression will be executed (instead of on the root context). They are normally set by means of th:objects.

      Specified by:
      getSelectionTarget in interface ITemplateContext
      Returns:
      the selection target, or null if there isn't any.

    • setSelectionTarget

      public void setSelectionTarget(Object selectionTarget)
      Description copied from interface: IEngineContext

      Set a selection target. Usually the consequence of executing a th:object processor.

      Once set, all selection expressions (*{...}) will be executed on this target.

      This selection target will have the consideration of a local variable and thus depend on the context level (see IEngineContext.setVariable(String, Object)).

      Specified by:
      setSelectionTarget in interface IEngineContext
      Parameters:
      selectionTarget - the selection target to be set.

    • getInliner

      public IInliner getInliner()
      Description copied from interface: ITemplateContext

      Returns the inliner (implementation of IInliner) set to be used at the current point of execution.

      Specified by:
      getInliner in interface ITemplateContext
      Returns:
      the inliner to be used.

    • setInliner

      public void setInliner(IInliner inliner)
      Description copied from interface: IEngineContext

      Set an inliner. Usually the consequence of executing a th:inline processor.

      This inliner will have the consideration of a local variable and thus depend on the context level (see IEngineContext.setVariable(String, Object)).

      Specified by:
      setInliner in interface IEngineContext
      Parameters:
      inliner - the inliner to be set.

    • getTemplateData

      public TemplateData getTemplateData()
      Description copied from interface: ITemplateContext

      Returns the template data object containing metadata about the template currently being processed.

      Note that the TemplateData returned here corresponds with the origin of the elements or nodes being currently processed. This is, if a processor is being executed for an element inserted from an external template (via a th:insert, for example), then this method will return the template data for the template in which the inserted fragment lives, not the one it was inserted into.

      Specified by:
      getTemplateData in interface ITemplateContext
      Returns:
      the template data corresponding to the elements or nodes being currently processed.

    • setTemplateData

      public void setTemplateData(TemplateData templateData)
      Description copied from interface: IEngineContext

      Sets a new template metadata object (TemplateData) for the current execution point, specifying that the elements and nodes that are to be processed from now on (until the context level is decreased below the current level) originally belonged to a different template.

      A call on this method is usually the consequence of th:insert or th:replace.

      Specified by:
      setTemplateData in interface IEngineContext
      Parameters:
      templateData - the template data.

    • getTemplateStack

      public List<TemplateData> getTemplateStack()
      Description copied from interface: ITemplateContext

      Returns the list of all the TemplateData objects corresponding to all the templates that have been nested in order to reach the current execution point.

      This is a way in which processors can know the complete execution route that lead to the execution of a specific event (e.g. Template A inserted fragment B, which inserted fragment C).

      The first element in this list will always be the top-level template (the one called at the ITemplateEngine process(...) methods).

      Specified by:
      getTemplateStack in interface ITemplateContext
      Returns:
      the stack of templates (list of TemplateData).

    • setElementTag

      public void setElementTag(IProcessableElementTag elementTag)
      Description copied from interface: IEngineContext

      Sets a new element tag (IProcessableElementTag) into the hierarchy (stack) of element tags.

      This hierarchy of element tags (added this way) can be obtained with ITemplateContext.getElementStack().

      Specified by:
      setElementTag in interface IEngineContext
      Parameters:
      elementTag - the element tag.

    • getElementStack

      public List<IProcessableElementTag> getElementStack()
      Description copied from interface: ITemplateContext

      Returns the list of all the IProcessableElementTag objects corresponding to the hierarchy of elements (open or standalone elements) that had to be processed in order to reach the current point in execution.

      If the element being processed is a tag (open/standalone), it will appear at the end of the list.

      Note this hierarchy does not correspond with the tag hierarchy at the original template, but with the hierarchy of processing (many tags could appear during processing itself and not be present at the original template).

      Also note that, because of this being the processing-time hierarchy, this information is set at the processor level, so it should not be considered to be available and/or valid at the pre-processor layer.

      Specified by:
      getElementStack in interface ITemplateContext
      Returns:
      the stack of elements (list of IProcessableElementTag).

    • getElementStackAbove

      public List<IProcessableElementTag> getElementStackAbove(int contextLevel)
      Description copied from interface: IEngineContext

      Retrieves the element stack just like ITemplateContext.getElementStack(), but only for those elements added to the hierarchy above a specific context level.

      Specified by:
      getElementStackAbove in interface IEngineContext
      Parameters:
      contextLevel - the level above which we want to obtain the element stack.
      Returns:
      the element stack above a specified level.

    • level

      public int level()
      Description copied from interface: IEngineContext

      Return the current context level.

      This method should only be called internally.

      Specified by:
      level in interface IEngineContext
      Returns:
      the current level

    • increaseLevel

      public void increaseLevel()
      Description copied from interface: IEngineContext

      Increase the context level. This is usually a consequence of the ProcessorTemplateHandler detecting the start of a new element (i.e. handling an IOpenElementTag event).

      This method should only be called internally.

      Specified by:
      increaseLevel in interface IEngineContext

    • decreaseLevel

      public void decreaseLevel()
      Description copied from interface: IEngineContext

      Decrease the context level. This is usually a consequence of the ProcessorTemplateHandler detecting the closing of an element (i.e. handling an ICloseElementTag event).

      This method should only be called internally.

      Specified by:
      decreaseLevel in interface IEngineContext

    • getStringRepresentationByLevel

      public String getStringRepresentationByLevel()

    • toString

      public String toString()
      Overrides:
      toString in class Object