Interface ITemplateResource

    • Method Detail

      • getDescription

        String getDescription()

        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.

        the resource description. Should never return null.
      • getBaseName

        String getBaseName()

        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 relative(String).

        the base name, or null if it cannot be computed for the specific type of resource.
      • exists

        boolean exists()

        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.

        true if the resource exists, false if not.
      • reader

        Reader reader()
               throws IOException

        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.

        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

        ITemplateResource relative​(String relativeLocation)

        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.

        relativeLocation - the location of the resource we want to obtain, relative to the current one. Required.
        the relative resource. Should never return null.