Package org.thymeleaf.templateresource

Class WebApplicationTemplateResource

  • All Implemented Interfaces:
    ITemplateResource
    public final class WebApplicationTemplateResource
extends java.lang.Object
implements ITemplateResource

    Implementation of ITemplateResource accessible from the context of a web application. The paths of these resources start at the web application file root which, for instance, in servlet-based applications is /WEB-INF.

    Objects of this class are usually created by WebApplicationTemplateResolver.

    Since:
    3.1.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean exists()
      Determines whether the resource represented by this object really exists or not.
      java.lang.String getBaseName()
      Returns the base name of a resource.
      java.lang.String getDescription()
      Returns a String describing the resource.
      java.io.Reader reader()
      Returns a Reader that can be used for consuming the template contents.
      ITemplateResource relative​(java.lang.String relativeLocation)
      Creates another ITemplateResource, usually of the same implementation class, for a resource living in a location relative to the current object's.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • path

        private final java.lang.String path

      • characterEncoding

        private final java.lang.String characterEncoding

    • Constructor Detail

      • WebApplicationTemplateResource

        public WebApplicationTemplateResource​(IWebApplication webApplication,
                                      java.lang.String path,
                                      java.lang.String characterEncoding)

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: ITemplateResource

        Returns a String describing the resource.

        Note this should not be taken for a valid resource name, as depending on the implementation it could be too verbose/descriptive or not unique enough to be used for identification purposes.

        Specified by:
        getDescription in interface ITemplateResource
        Returns:
        the resource description. Should never return null.

      • getBaseName

        public java.lang.String getBaseName()
        Description copied from interface: ITemplateResource

        Returns the base name of a resource.

        The base name is aimed at creating derivative names from the name of the resource, usually from the deepest level of the resource path.

        For example, a file resource located at /home/user/template/main.html should return main as its base name, so that names like main.properties, main.th.xml or similar can be derived, and afterwards resolved using ITemplateResource.relative(String).

        Specified by:
        getBaseName in interface ITemplateResource
        Returns:
        the base name, or null if it cannot be computed for the specific type of resource.

      • reader

        public java.io.Reader reader()
                      throws java.io.IOException
        Description copied from interface: ITemplateResource

        Returns a Reader that can be used for consuming the template contents.

        Most implementations of this interface will require specifying a character encoding during construction, so that this readers are correctly able to decode their underlying input streams.

        Note this readers should be closed after being fully consumed, just like any other resources.

        Specified by:
        reader in interface ITemplateResource
        Returns:
        a Reader on the template contents. Should never return null.
        Throws:
        java.io.IOException - if an input/output exception happens or if the resource does not exist (e.g. FileNotFoundException).

      • relative

        public ITemplateResource relative​(java.lang.String relativeLocation)
        Description copied from interface: ITemplateResource

        Creates another ITemplateResource, usually of the same implementation class, for a resource living in a location relative to the current object's.

        Note some ITemplateResource implementations might not support this feature.

        Specified by:
        relative in interface ITemplateResource
        Parameters:
        relativeLocation - the location of the resource we want to obtain, relative to the current one. Required.
        Returns:
        the relative resource. Should never return null.

      • exists

        public boolean exists()
        Description copied from interface: ITemplateResource

        Determines whether the resource represented by this object really exists or not.

        Note that, depending on the implementation, this might mean actually access the resource, and such operation could have a cost in performance in some scenarios (e.g. a resource representing a remote URL).

        This mechanism will be used by Template Resolvers extending from AbstractTemplateResolver for checking real resource existence if the AbstractTemplateResolver.setCheckExistence(boolean) flag is set to true.

        Specified by:
        exists in interface ITemplateResource
        Returns:
        true if the resource exists, false if not.