Class FileResource

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, ResourceFactory

    @Deprecated
    public class FileResource
    extends Resource
    Deprecated.
    File Resource. Handle resources of implied or explicit file type. This class can check for aliasing in the filesystem (eg case insensitivity). By default this is turned on, or it can be controlled by calling the static method @see FileResource#setCheckAliases(boolean)
    • Constructor Detail

      • FileResource

        public FileResource​(java.net.URL url)
                     throws java.io.IOException,
                            java.net.URISyntaxException
        Deprecated.
        Throws:
        java.io.IOException
        java.net.URISyntaxException
      • FileResource

        public FileResource​(java.net.URI uri)
        Deprecated.
      • FileResource

        public FileResource​(java.io.File file)
        Deprecated.
      • FileResource

        public FileResource​(java.io.File base,
                            java.lang.String childPath)
        Deprecated.
    • Method Detail

      • addPath

        public Resource addPath​(java.lang.String path)
                         throws java.io.IOException
        Deprecated.
        Description copied from class: Resource
        Returns the resource contained inside the current resource with the given name.
        Specified by:
        addPath in class Resource
        Parameters:
        path - The path segment to add, which is not encoded
        Returns:
        the Resource for the resolved path within this Resource.
        Throws:
        java.io.IOException - if unable to resolve the path
        java.net.MalformedURLException - if the resolution of the path fails because the input path parameter is malformed.
      • getAlias

        public java.net.URI getAlias()
        Deprecated.
        Overrides:
        getAlias in class Resource
        Returns:
        The canonical Alias of this resource or null if none.
      • exists

        public boolean exists()
        Deprecated.
        Returns true if the resource exists.
        Specified by:
        exists in class Resource
        Returns:
        true if the represented resource exists.
      • lastModified

        public long lastModified()
        Deprecated.
        Returns the last modified time
        Specified by:
        lastModified in class Resource
        Returns:
        the last modified time as milliseconds since unix epoch
      • isDirectory

        public boolean isDirectory()
        Deprecated.
        Returns true if the resource is a container/directory.
        Specified by:
        isDirectory in class Resource
        Returns:
        true if the represented resource is a container/directory. if the resource is not a file, resources ending with "/" are considered directories.
      • length

        public long length()
        Deprecated.
        Return the length of the resource
        Specified by:
        length in class Resource
        Returns:
        the length of the resource
      • getName

        public java.lang.String getName()
        Deprecated.
        Returns the name of the resource
        Specified by:
        getName in class Resource
        Returns:
        the name of the resource
      • getFile

        public java.io.File getFile()
        Deprecated.
        Returns an File representing the given resource or NULL if this is not possible.
        Specified by:
        getFile in class Resource
        Returns:
        an File representing the given resource or NULL if this is not possible.
      • getInputStream

        public java.io.InputStream getInputStream()
                                           throws java.io.IOException
        Deprecated.
        Returns an input stream to the resource
        Specified by:
        getInputStream in class Resource
        Returns:
        an input stream to the resource
        Throws:
        java.io.IOException - if unable to open the input stream
      • getReadableByteChannel

        public java.nio.channels.ReadableByteChannel getReadableByteChannel()
                                                                     throws java.io.IOException
        Deprecated.
        Description copied from class: Resource
        Readable ByteChannel for the resource.
        Specified by:
        getReadableByteChannel in class Resource
        Returns:
        an readable bytechannel to the resource or null if one is not available.
        Throws:
        java.io.IOException - if unable to open the readable bytechannel for the resource.
      • delete

        public boolean delete()
                       throws java.lang.SecurityException
        Deprecated.
        Deletes the given resource
        Specified by:
        delete in class Resource
        Returns:
        true if resource was found and successfully deleted, false if resource didn't exist or was unable to be deleted.
        Throws:
        java.lang.SecurityException - if unable to delete due to permissions
      • renameTo

        public boolean renameTo​(Resource dest)
                         throws java.lang.SecurityException
        Deprecated.
        Rename the given resource
        Specified by:
        renameTo in class Resource
        Parameters:
        dest - the destination name for the resource
        Returns:
        true if the resource was renamed, false if the resource didn't exist or was unable to be renamed.
        Throws:
        java.lang.SecurityException - if unable to rename due to permissions
      • list

        public java.lang.String[] list()
        Deprecated.
        Returns a list of resources contained in the given resource
        Specified by:
        list in class Resource
        Returns:
        a list of resource names contained in the given resource, or null. Note: The resource names are not URL encoded.
      • equals

        public boolean equals​(java.lang.Object o)
        Deprecated.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - the object to compare against this instance
        Returns:
        true of the object o is a FileResource pointing to the same file as this resource.
      • hashCode

        public int hashCode()
        Deprecated.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hashcode.
      • copyTo

        public void copyTo​(java.io.File destination)
                    throws java.io.IOException
        Deprecated.
        Description copied from class: Resource
        Copy the Resource to the new destination file.

        Will not replace existing destination file.

        Overrides:
        copyTo in class Resource
        Parameters:
        destination - the destination file to create
        Throws:
        java.io.IOException - if unable to copy the resource
      • isContainedIn

        public boolean isContainedIn​(Resource r)
                              throws java.net.MalformedURLException
        Deprecated.
        Specified by:
        isContainedIn in class Resource
        Throws:
        java.net.MalformedURLException
      • close

        public void close()
        Deprecated.
        Description copied from class: Resource
        Release any temporary resources held by the resource.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class Resource
      • getURL

        public java.net.URL getURL()
        Deprecated.
        Description copied from class: Resource
        URL representing the resource.
        Specified by:
        getURL in class Resource
        Returns:
        an URL representing the given resource
      • getURI

        public java.net.URI getURI()
        Deprecated.
        Description copied from class: Resource
        URI representing the resource.
        Overrides:
        getURI in class Resource
        Returns:
        an URI representing the given resource
      • toString

        public java.lang.String toString()
        Deprecated.
        Overrides:
        toString in class java.lang.Object