Interface FileObject

    • Method Detail

      • getName

        FileName getName()
        Returns the name of this file.
      • exists

        boolean exists()
                throws FileSystemException
        Determines if this file exists.
        Returns:
        true if this file exists, false if not.
        Throws:
        FileSystemException - On error determining if this file exists.
      • isHidden

        boolean isHidden()
                  throws FileSystemException
        Determines if this file is hidden.
        Returns:
        true if this file is hidden, false if not.
        Throws:
        FileSystemException - On error determining if this file exists.
      • isReadable

        boolean isReadable()
                    throws FileSystemException
        Determines if this file can be read.
        Returns:
        true if this file is readable, false if not.
        Throws:
        FileSystemException - On error determining if this file exists.
      • isWriteable

        boolean isWriteable()
                     throws FileSystemException
        Determines if this file can be written to.
        Returns:
        true if this file is writeable, false if not.
        Throws:
        FileSystemException - On error determining if this file exists.
      • getParent

        FileObject getParent()
                      throws FileSystemException
        Returns the folder that contains this file.
        Returns:
        The folder that contains this file. Returns null if this file is the root of a file system.
        Throws:
        FileSystemException - On error finding the file's parent.
      • getFileSystem

        FileSystem getFileSystem()
        Returns the file system that contains this file.
        Returns:
        The file system.
      • getChildren

        FileObject[] getChildren()
                          throws FileSystemException
        Lists the children of this file.
        Returns:
        An array containing the children of this file. The array is unordered. If the file does not have any children, a zero-length array is returned. This method never returns null.
        Throws:
        FileSystemException - If this file does not exist, or is not a folder, or on error listing this file's children.
      • getChild

        FileObject getChild​(java.lang.String name)
                     throws FileSystemException
        Returns a child of this file. Note that this method returns null when the child does not exist. This differs from resolveFile( String, NameScope) which never returns null.
        Parameters:
        name - The name of the child.
        Returns:
        The child, or null if there is no such child.
        Throws:
        FileSystemException - If this file does not exist, or is not a folder, or on error determining this file's children.
      • resolveFile

        FileObject resolveFile​(java.lang.String name,
                               NameScope scope)
                        throws FileSystemException
        Finds a file, relative to this file. Refer to NameScope for a description of how names are resolved in the different scopes.
        Parameters:
        name - The name to resolve.
        Returns:
        The file.
        Throws:
        FileSystemException - On error parsing the path, or on error finding the file.
      • resolveFile

        FileObject resolveFile​(java.lang.String path)
                        throws FileSystemException
        Finds a file, relative to this file. Equivalent to calling resolveFile( path, NameScope.FILE_SYSTEM ).
        Parameters:
        path - The path of the file to locate. Can either be a relative path or an absolute path.
        Returns:
        The file.
        Throws:
        FileSystemException - On error parsing the path, or on error finding the file.
      • findFiles

        FileObject[] findFiles​(FileSelector selector)
                        throws FileSystemException
        Finds the set of matching descendents of this file, in depthwise order.
        Parameters:
        selector - The selector to use to select matching files.
        Returns:
        The matching files. The files are returned in depthwise order (that is, a child appears in the list before its parent).
        Throws:
        FileSystemException
      • findFiles

        void findFiles​(FileSelector selector,
                       boolean depthwise,
                       java.util.List selected)
                throws FileSystemException
        Finds the set of matching descendents of this file.
        Parameters:
        selector - the selector used to determine if the file should be selected
        depthwise - controls the ordering in the list. e.g. deepest first
        selected - container for selected files. list needs not to be empty.
        Throws:
        FileSystemException
      • delete

        boolean delete()
                throws FileSystemException
        Deletes this file. Does nothing if this file does not exist of if it is a folder that has children. Does not delete any descendents of this file, use delete(FileSelector) for that.
        Returns:
        true if this object has been deleted
        Throws:
        FileSystemException - If this file is a non-empty folder, or if this file is read-only, or on error deleteing this file.
      • delete

        int delete​(FileSelector selector)
            throws FileSystemException
        Deletes all descendents of this file that match a selector. Does nothing if this file does not exist.

        This method is not transactional. If it fails and throws an exception, this file will potentially only be partially deleted.

        Parameters:
        selector - The selector to use to select which files to delete.
        Returns:
        the number of deleted objects
        Throws:
        FileSystemException - If this file or one of its descendents is read-only, or on error deleting this file or one of its descendents.
      • createFolder

        void createFolder()
                   throws FileSystemException
        Creates this folder, if it does not exist. Also creates any ancestor folders which do not exist. This method does nothing if the folder already exists.
        Throws:
        FileSystemException - If the folder already exists with the wrong type, or the parent folder is read-only, or on error creating this folder or one of its ancestors.
      • createFile

        void createFile()
                 throws FileSystemException
        Creates this file, if it does not exist. Also creates any ancestor folders which do not exist. This method does nothing if the file already exists and is a file.
        Throws:
        FileSystemException - If the file already exists with the wrong type, or the parent folder is read-only, or on error creating this file or one of its ancestors.
      • copyFrom

        void copyFrom​(FileObject srcFile,
                      FileSelector selector)
               throws FileSystemException
        Copies another file, and all its descendents, to this file.

        If this file does not exist, it is created. Its parent folder is also created, if necessary. If this file does exist, it is deleted first.

        This method is not transactional. If it fails and throws an exception, this file will potentially only be partially copied.

        Parameters:
        srcFile - The source file to copy.
        selector - The selector to use to select which files to copy.
        Throws:
        FileSystemException - If this file is read-only, or if the source file does not exist, or on error copying the file.
      • moveTo

        void moveTo​(FileObject destFile)
             throws FileSystemException
        Move this file.

        If the destFile exists, it is deleted first

        Parameters:
        destFile - the New filename.
        Throws:
        FileSystemException - If this file is read-only, or if the source file does not exist, or on error copying the file.
      • canRenameTo

        boolean canRenameTo​(FileObject newfile)
        Queries the file if it is possible to rename it to newfile.
        Parameters:
        newfile - the new file(-name)
        Returns:
        true it this is the case
      • getContent

        FileContent getContent()
                        throws FileSystemException
        Returns this file's content. The FileContent returned by this method can be used to read and write the content of the file.

        This method can be called if the file does not exist, and the returned FileContent can be used to create the file by writing its content.

        Returns:
        This file's content.
        Throws:
        FileSystemException - On error getting this file's content.
      • close

        void close()
            throws FileSystemException
        Closes this file, and its content. This method is a hint to the implementation that it can release any resources associated with the file.

        The file object can continue to be used after this method is called.

        Throws:
        FileSystemException - On error closing the file.
        See Also:
        FileContent.close()
      • isAttached

        boolean isAttached()
        check if the fileObject is attaced
      • isContentOpen

        boolean isContentOpen()
        check if someone reads/write to this file