Class ServletContextTemplateResource

  • All Implemented Interfaces:

    public final class ServletContextTemplateResource
    extends Object
    implements ITemplateResource

    Implementation of ITemplateResource accessible from the ServletContext in a web application. The paths of these resources start at the web application root, and are normally stored inside /WEB-INF.

    Objects of this class are usually created by ServletContextTemplateResolver.

    Daniel Fernández
    • Constructor Detail

      • ServletContextTemplateResource

        public ServletContextTemplateResource​(javax.servlet.ServletContext servletContext,
                                              String path,
                                              String characterEncoding)
    • Method Detail

      • getDescription

        public 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
        the resource description. Should never return null.
      • getBaseName

        public 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, or similar can be derived, and afterwards resolved using ITemplateResource.relative(String).

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

        public Reader reader()
                      throws 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
        a Reader on the template contents. Should never return null.
        IOException - if an input/output exception happens or if the resource does not exist (e.g. FileNotFoundException).
      • relative

        public ITemplateResource relative​(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
        relativeLocation - the location of the resource we want to obtain, relative to the current one. Required.
        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
        true if the resource exists, false if not.