Package org.thymeleaf.context

Class AbstractContext

  • All Implemented Interfaces:
    IContext
    Direct Known Subclasses:
    AbstractExpressionContext, Context, WebContext
    public abstract class AbstractContext
extends java.lang.Object
implements IContext

    Abstract base class for most IContext implementations.

    Note a class with this name existed since 1.0, but it was completely reimplemented in Thymeleaf 3.0

    Since:
    3.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Locale locale  
      private java.util.Map<java.lang.String,​java.lang.Object> variables  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractContext()  
      protected AbstractContext​(java.util.Locale locale)  
      protected AbstractContext​(java.util.Locale locale, java.util.Map<java.lang.String,​java.lang.Object> variables)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearVariables()
      Removes all the variables from the context.
      boolean containsVariable​(java.lang.String name)
      Checks whether a specific variable is already contained in this context or not.
      java.util.Locale getLocale()
      Returns the locale that should be used for processing the template.
      java.lang.Object getVariable​(java.lang.String name)
      Retrieve a specific variable, by name.
      java.util.Set<java.lang.String> getVariableNames()
      Get a list with all the names of variables contained at this context.
      void removeVariable​(java.lang.String name)
      Removes a variable from the context.
      void setLocale​(java.util.Locale locale)
      Sets the locale to be used.
      void setVariable​(java.lang.String name, java.lang.Object value)
      Sets a new variable into the context.
      void setVariables​(java.util.Map<java.lang.String,​java.lang.Object> variables)
      Sets several variables at a time into the context.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • variables

        private final java.util.Map<java.lang.String,​java.lang.Object> variables

      • locale

        private java.util.Locale locale

    • Constructor Detail

      • AbstractContext

        protected AbstractContext()

      • AbstractContext

        protected AbstractContext​(java.util.Locale locale)

      • AbstractContext

        protected AbstractContext​(java.util.Locale locale,
                          java.util.Map<java.lang.String,​java.lang.Object> variables)

    • Method Detail

      • getLocale

        public final java.util.Locale getLocale()
        Description copied from interface: IContext

        Returns the locale that should be used for processing the template.

        Specified by:
        getLocale in interface IContext
        Returns:
        the locale to be used.

      • containsVariable

        public final boolean containsVariable​(java.lang.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.

      • getVariableNames

        public final java.util.Set<java.lang.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.

      • getVariable

        public final java.lang.Object getVariable​(java.lang.String name)
        Description copied from interface: IContext

        Retrieve a specific variable, by name.

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

      • setLocale

        public void setLocale​(java.util.Locale locale)

        Sets the locale to be used.

        Parameters:
        locale - the locale.

      • setVariable

        public void setVariable​(java.lang.String name,
                        java.lang.Object value)

        Sets a new variable into the context.

        Parameters:
        name - the name of the variable.
        value - the value of the variable.

      • setVariables

        public void setVariables​(java.util.Map<java.lang.String,​java.lang.Object> variables)

        Sets several variables at a time into the context.

        Parameters:
        variables - the variables to be set.

      • removeVariable

        public void removeVariable​(java.lang.String name)

        Removes a variable from the context.

        Parameters:
        name - the name of the variable to be removed.

      • clearVariables

        public void clearVariables()

        Removes all the variables from the context.