Class AbstractResource

    • Method Detail

      • getPath

        public final String getPath()
        Description copied from interface: Resource
        Return the path (the combination of folder and file). Starting in 5.4, certain "virtual resources", may return an arbitrary value here.
        Specified by:
        getPath in interface Resource
      • getFile

        public final String getFile()
        Description copied from interface: Resource
        Returns the file portion of the Resource path, everything that follows the final forward slash. Starting in 5.4, certain kinds of "virtual resources" may return null here.
        Specified by:
        getFile in interface Resource
      • getFolder

        public final String getFolder()
        Description copied from interface: Resource
        Returns the portion of the path up to the last forward slash; this is the directory or folder portion of the Resource.
        Specified by:
        getFolder in interface Resource
      • forFile

        public final Resource forFile​(String relativePath)
        Description copied from interface: Resource
        Returns a Resource based on a relative path, relative to the folder containing the resource. Understands the "." (current folder) and ".." (parent folder) conventions, and treats multiple sequential slashes as a single slash. Virtual resources (resources fabricated at runtime) return themselves.
        Specified by:
        forFile in interface Resource
      • forLocale

        public final Resource forLocale​(Locale locale)
        Description copied from interface: Resource
        Returns a localized version of the resource. May return null if no such resource exists. Starting in release 5.3.4, the result of this method is cached internally.
        Specified by:
        forLocale in interface Resource
      • withExtension

        public final Resource withExtension​(String extension)
        Description copied from interface: Resource
        Returns a new Resource with the extension changed (or, if the resource does not have an extension, the extension is added). The new Resource may not exist (that is, Resource.toURL() may return null.
        Specified by:
        withExtension in interface Resource
        extension - to apply to the resource, such as "html" or "properties"
        the new resource
      • exists

        public boolean exists()
        Simple check for whether Resource.toURL() returns null or not.
        Specified by:
        exists in interface Resource
        true if the resource exists, false if it does not
      • validateURL

        protected void validateURL​(URL url)
        Validates that the URL is correct; at this time, a correct URL is one of:
        • null
        • a non-file: URL
        • a file: URL where the case of the file matches the corresponding path element
        See TAP5-1007
        url - to validate