Package org.apache.commons.io.file

Class PathUtils

  • public final class PathUtils
extends Object
    NIO Path utilities.
    Since:
    2.7

    • Method Detail

      • cleanDirectory

        public static Counters.PathCounters cleanDirectory​(Path directory)
                                            throws IOException
        Cleans a directory including sub-directories without deleting directories.
        Parameters:
        directory - directory to clean.
        Returns:
        The visitation path counters.
        Throws:
        IOException - if an I/O error is thrown by a visitor method.

      • cleanDirectory

        public static Counters.PathCounters cleanDirectory​(Path directory,
                                                   DeleteOption... options)
                                            throws IOException
        Cleans a directory including sub-directories without deleting directories.
        Parameters:
        directory - directory to clean.
        options - options indicating how deletion is handled.
        Returns:
        The visitation path counters.
        Throws:
        IOException - if an I/O error is thrown by a visitor method.
        Since:
        2.8.0

      • copyDirectory

        public static Counters.PathCounters copyDirectory​(Path sourceDirectory,
                                                  Path targetDirectory,
                                                  CopyOption... copyOptions)
                                           throws IOException
        Copies a directory to another directory.
        Parameters:
        sourceDirectory - The source directory.
        targetDirectory - The target directory.
        copyOptions - Specifies how the copying should be done.
        Returns:
        The visitation path counters.
        Throws:
        IOException - if an I/O error is thrown by a visitor method.

      • copyFileToDirectory

        public static Path copyFileToDirectory​(Path sourceFile,
                                       Path targetDirectory,
                                       CopyOption... copyOptions)
                                throws IOException
        Copies a file to a directory.
        Parameters:
        sourceFile - The source file.
        targetDirectory - The target directory.
        copyOptions - Specifies how the copying should be done.
        Returns:
        The target file
        Throws:
        IOException - if an I/O error occurs
        See Also:
        Files.copy(Path, Path, CopyOption...)

      • copyFileToDirectory

        public static Path copyFileToDirectory​(URL sourceFile,
                                       Path targetDirectory,
                                       CopyOption... copyOptions)
                                throws IOException
        Copies a URL to a directory.
        Parameters:
        sourceFile - The source URL.
        targetDirectory - The target directory.
        copyOptions - Specifies how the copying should be done.
        Returns:
        The target file
        Throws:
        IOException - if an I/O error occurs
        See Also:
        Files.copy(InputStream, Path, CopyOption...)

      • countDirectory

        public static Counters.PathCounters countDirectory​(Path directory)
                                            throws IOException
        Counts aspects of a directory including sub-directories.
        Parameters:
        directory - directory to delete.
        Returns:
        The visitor used to count the given directory.
        Throws:
        IOException - if an I/O error is thrown by a visitor method.

      • delete

        public static Counters.PathCounters delete​(Path path)
                                    throws IOException
        Deletes a file or directory. If the path is a directory, delete it and all sub-directories.

        The difference between File.delete() and this method are:

        • A directory to delete does not have to be empty.
        • You get exceptions when a file or directory cannot be deleted; File.delete() returns a boolean.
        Parameters:
        path - file or directory to delete, must not be null
        Returns:
        The visitor used to delete the given directory.
        Throws:
        NullPointerException - if the directory is null
        IOException - if an I/O error is thrown by a visitor method or if an I/O error occurs.

      • delete

        public static Counters.PathCounters delete​(Path path,
                                           DeleteOption... options)
                                    throws IOException
        Deletes a file or directory. If the path is a directory, delete it and all sub-directories.

        The difference between File.delete() and this method are:

        • A directory to delete does not have to be empty.
        • You get exceptions when a file or directory cannot be deleted; File.delete() returns a boolean.
        Parameters:
        path - file or directory to delete, must not be null
        options - options indicating how deletion is handled.
        Returns:
        The visitor used to delete the given directory.
        Throws:
        NullPointerException - if the directory is null
        IOException - if an I/O error is thrown by a visitor method or if an I/O error occurs.
        Since:
        2.8.0

      • deleteDirectory

        public static Counters.PathCounters deleteDirectory​(Path directory)
                                             throws IOException
        Deletes a directory including sub-directories.
        Parameters:
        directory - directory to delete.
        Returns:
        The visitor used to delete the given directory.
        Throws:
        IOException - if an I/O error is thrown by a visitor method.

      • deleteDirectory

        public static Counters.PathCounters deleteDirectory​(Path directory,
                                                    DeleteOption... options)
                                             throws IOException
        Deletes a directory including sub-directories.
        Parameters:
        directory - directory to delete.
        options - options indicating how deletion is handled.
        Returns:
        The visitor used to delete the given directory.
        Throws:
        IOException - if an I/O error is thrown by a visitor method.
        Since:
        2.8.0

      • deleteFile

        public static Counters.PathCounters deleteFile​(Path file)
                                        throws IOException
        Deletes the given file.
        Parameters:
        file - The file to delete.
        Returns:
        A visitor with path counts set to 1 file, 0 directories, and the size of the deleted file.
        Throws:
        IOException - if an I/O error occurs.
        NoSuchFileException - if the file is a directory.

      • deleteFile

        public static Counters.PathCounters deleteFile​(Path file,
                                               DeleteOption... options)
                                        throws IOException
        Deletes the given file.
        Parameters:
        file - The file to delete.
        options - options indicating how deletion is handled.
        Returns:
        A visitor with path counts set to 1 file, 0 directories, and the size of the deleted file.
        Throws:
        IOException - if an I/O error occurs.
        NoSuchFileException - if the file is a directory.
        Since:
        2.8.0

      • directoryAndFileContentEquals

        public static boolean directoryAndFileContentEquals​(Path path1,
                                                    Path path2)
                                             throws IOException
        Compares the file sets of two Paths to determine if they are equal or not while considering file contents. The comparison includes all files in all sub-directories.
        Parameters:
        path1 - The first directory.
        path2 - The second directory.
        Returns:
        Whether the two directories contain the same files while considering file contents.
        Throws:
        IOException - if an I/O error is thrown by a visitor method

      • directoryAndFileContentEquals

        public static boolean directoryAndFileContentEquals​(Path path1,
                                                    Path path2,
                                                    LinkOption[] linkOptions,
                                                    OpenOption[] openOptions,
                                                    FileVisitOption[] fileVisitOption)
                                             throws IOException
        Compares the file sets of two Paths to determine if they are equal or not while considering file contents. The comparison includes all files in all sub-directories.
        Parameters:
        path1 - The first directory.
        path2 - The second directory.
        linkOptions - options to follow links.
        openOptions - options to open files.
        fileVisitOption - options to configure traversal.
        Returns:
        Whether the two directories contain the same files while considering file contents.
        Throws:
        IOException - if an I/O error is thrown by a visitor method

      • directoryContentEquals

        public static boolean directoryContentEquals​(Path path1,
                                             Path path2)
                                      throws IOException
        Compares the file sets of two Paths to determine if they are equal or not without considering file contents. The comparison includes all files in all sub-directories.
        Parameters:
        path1 - The first directory.
        path2 - The second directory.
        Returns:
        Whether the two directories contain the same files without considering file contents.
        Throws:
        IOException - if an I/O error is thrown by a visitor method

      • directoryContentEquals

        public static boolean directoryContentEquals​(Path path1,
                                             Path path2,
                                             int maxDepth,
                                             LinkOption[] linkOptions,
                                             FileVisitOption[] fileVisitOptions)
                                      throws IOException
        Compares the file sets of two Paths to determine if they are equal or not without considering file contents. The comparison includes all files in all sub-directories.
        Parameters:
        path1 - The first directory.
        path2 - The second directory.
        maxDepth - See Files.walkFileTree(Path,Set,int,FileVisitor).
        linkOptions - options to follow links.
        fileVisitOptions - options to configure the traversal
        Returns:
        Whether the two directories contain the same files without considering file contents.
        Throws:
        IOException - if an I/O error is thrown by a visitor method

      • getAclEntryList

        public static List<AclEntry> getAclEntryList​(Path sourcePath)
                                      throws IOException
        Reads the access control list from a file attribute view.
        Parameters:
        sourcePath - the path to the file.
        Returns:
        a file attribute view of the specified type, or null ifthe attribute view type is not available.
        Throws:
        IOException - if an I/O error occurs.
        Since:
        2.8.0

      • isEmpty

        public static boolean isEmpty​(Path path)
                       throws IOException
        Returns whether the given file or directory is empty.
        Parameters:
        path - the the given file or directory to query.
        Returns:
        whether the given file or directory is empty.
        Throws:
        IOException - if an I/O error occurs

      • isEmptyDirectory

        public static boolean isEmptyDirectory​(Path directory)
                                throws IOException
        Returns whether the directory is empty.
        Parameters:
        directory - the the given directory to query.
        Returns:
        whether the given directory is empty.
        Throws:
        IOException - if an I/O error occurs

      • isEmptyFile

        public static boolean isEmptyFile​(Path file)
                           throws IOException
        Returns whether the given file is empty.
        Parameters:
        file - the the given file to query.
        Returns:
        whether the given file is empty.
        Throws:
        IOException - if an I/O error occurs

      • setReadOnly

        public static Path setReadOnly​(Path path,
                               boolean readOnly,
                               LinkOption... options)
                        throws IOException
        Sets the given Path to the readOnly value.

        This behavior is OS dependent.

        Parameters:
        path - The path to set.
        readOnly - true for read-only, false for not read-only.
        options - options indicating how symbolic links are handled.
        Returns:
        The given path.
        Throws:
        IOException - if an I/O error occurs.
        Since:
        2.8.0