Class FileUtils


  • @Internal
    public final class FileUtils
    extends java.lang.Object
    The FileUtils class has a lot of utility methods, for
    1. Byte Streams IO
    2. File IO (Coping, Deleting)
    3. Zip IO
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.io.InputStream EMPTY_STREAM  
    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static byte[] convert​(java.nio.file.Path... directories)
      Deprecated.
      May cause a heap space (over)load
      static void copy​(java.io.InputStream inputStream, java.io.OutputStream outputStream)  
      static void copy​(java.io.InputStream inputStream, java.io.OutputStream outputStream, byte[] buffer)  
      static void copy​(java.io.InputStream inputStream, java.io.OutputStream outputStream, byte[] buffer, java.util.function.Consumer<java.lang.Integer> lengthInputListener)  
      static void copy​(java.nio.file.Path from, java.nio.file.Path to)  
      static void copy​(java.nio.file.Path from, java.nio.file.Path to, byte[] buffer)  
      static void copyFilesToDirectory​(java.nio.file.Path from, java.nio.file.Path to)  
      static void copyFilesToDirectory​(java.nio.file.Path from, java.nio.file.Path to, java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)  
      static void createDirectoryReported​(@Nullable java.nio.file.Path directoryPath)  
      static java.nio.file.Path createTempFile()  
      static void delete​(java.nio.file.Path file)  
      static void deleteFileReported​(java.nio.file.Path file)  
      static byte[] emptyZipByteArray()  
      static java.nio.file.Path extract​(byte[] zipData, java.nio.file.Path targetDirectory)  
      static java.nio.file.Path extract​(java.io.InputStream inputStream, java.nio.file.Path targetDirectory)  
      static java.nio.file.Path extract​(java.nio.file.Path zipPath, java.nio.file.Path targetDirectory)  
      static void extract0​(java.util.zip.ZipInputStream zipInputStream, java.nio.file.Path targetDirectory)  
      static void openZipFileSystem​(java.nio.file.Path path, IVoidThrowableCallback<java.nio.file.FileSystem> consumer)  
      static byte[] toByteArray​(java.io.InputStream inputStream)  
      static byte[] toByteArray​(java.io.InputStream inputStream, byte[] buffer)  
      static void walkFileTree​(java.nio.file.Path rootDirectoryPath, java.util.function.BiConsumer<java.nio.file.Path,​java.nio.file.Path> consumer)  
      static void walkFileTree​(java.nio.file.Path rootDirectoryPath, java.util.function.BiConsumer<java.nio.file.Path,​java.nio.file.Path> consumer, boolean visitDirectories)  
      static void walkFileTree​(java.nio.file.Path rootDirectoryPath, java.util.function.BiConsumer<java.nio.file.Path,​java.nio.file.Path> consumer, boolean visitDirectories, java.lang.String glob)  
      static void walkFileTree​(java.nio.file.Path rootDirectoryPath, java.util.function.BiConsumer<java.nio.file.Path,​java.nio.file.Path> consumer, boolean visitDirectories, java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)  
      static @Nullable java.nio.file.Path zipToFile​(java.nio.file.Path directory, java.nio.file.Path target)  
      static @Nullable java.nio.file.Path zipToFile​(java.nio.file.Path directory, java.nio.file.Path target, java.util.function.Predicate<java.nio.file.Path> fileFilter)  
      static @NotNull java.io.InputStream zipToStream​(@NotNull java.nio.file.Path directory)  
      static @NotNull java.io.InputStream zipToStream​(@NotNull java.nio.file.Path directory, java.util.function.Predicate<java.nio.file.Path> fileFilter)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • EMPTY_STREAM

        public static final java.io.InputStream EMPTY_STREAM
    • Method Detail

      • toByteArray

        public static byte[] toByteArray​(java.io.InputStream inputStream)
      • toByteArray

        public static byte[] toByteArray​(java.io.InputStream inputStream,
                                         byte[] buffer)
      • openZipFileSystem

        public static void openZipFileSystem​(java.nio.file.Path path,
                                             IVoidThrowableCallback<java.nio.file.FileSystem> consumer)
      • copy

        public static void copy​(java.io.InputStream inputStream,
                                java.io.OutputStream outputStream)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • copy

        public static void copy​(java.io.InputStream inputStream,
                                java.io.OutputStream outputStream,
                                byte[] buffer)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • copy

        public static void copy​(java.io.InputStream inputStream,
                                java.io.OutputStream outputStream,
                                byte[] buffer,
                                java.util.function.Consumer<java.lang.Integer> lengthInputListener)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • copy

        public static void copy​(java.nio.file.Path from,
                                java.nio.file.Path to)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • copy

        public static void copy​(java.nio.file.Path from,
                                java.nio.file.Path to,
                                byte[] buffer)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • copyFilesToDirectory

        public static void copyFilesToDirectory​(java.nio.file.Path from,
                                                java.nio.file.Path to)
      • copyFilesToDirectory

        public static void copyFilesToDirectory​(java.nio.file.Path from,
                                                java.nio.file.Path to,
                                                java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)
      • delete

        public static void delete​(java.nio.file.Path file)
      • convert

        @Deprecated
        public static byte[] convert​(java.nio.file.Path... directories)
        Deprecated.
        May cause a heap space (over)load
        Converts a bunch of directories to a byte array
        Parameters:
        directories - The directories which should get converted
        Returns:
        A byte array of a zip file created from the provided directories
      • createTempFile

        public static java.nio.file.Path createTempFile()
      • zipToStream

        @NotNull
        public static @NotNull java.io.InputStream zipToStream​(@NotNull
                                                               @NotNull java.nio.file.Path directory)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • zipToStream

        @NotNull
        public static @NotNull java.io.InputStream zipToStream​(@NotNull
                                                               @NotNull java.nio.file.Path directory,
                                                               java.util.function.Predicate<java.nio.file.Path> fileFilter)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • zipToFile

        @Nullable
        public static @Nullable java.nio.file.Path zipToFile​(java.nio.file.Path directory,
                                                             java.nio.file.Path target)
      • zipToFile

        @Nullable
        public static @Nullable java.nio.file.Path zipToFile​(java.nio.file.Path directory,
                                                             java.nio.file.Path target,
                                                             java.util.function.Predicate<java.nio.file.Path> fileFilter)
      • extract

        public static java.nio.file.Path extract​(java.nio.file.Path zipPath,
                                                 java.nio.file.Path targetDirectory)
                                          throws java.io.IOException
        Throws:
        java.io.IOException
      • extract

        public static java.nio.file.Path extract​(java.io.InputStream inputStream,
                                                 java.nio.file.Path targetDirectory)
                                          throws java.io.IOException
        Throws:
        java.io.IOException
      • extract

        public static java.nio.file.Path extract​(byte[] zipData,
                                                 java.nio.file.Path targetDirectory)
                                          throws java.io.IOException
        Throws:
        java.io.IOException
      • extract0

        public static void extract0​(java.util.zip.ZipInputStream zipInputStream,
                                    java.nio.file.Path targetDirectory)
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • emptyZipByteArray

        public static byte[] emptyZipByteArray()
      • walkFileTree

        public static void walkFileTree​(java.nio.file.Path rootDirectoryPath,
                                        java.util.function.BiConsumer<java.nio.file.Path,​java.nio.file.Path> consumer)
      • walkFileTree

        public static void walkFileTree​(java.nio.file.Path rootDirectoryPath,
                                        java.util.function.BiConsumer<java.nio.file.Path,​java.nio.file.Path> consumer,
                                        boolean visitDirectories)
      • walkFileTree

        public static void walkFileTree​(java.nio.file.Path rootDirectoryPath,
                                        java.util.function.BiConsumer<java.nio.file.Path,​java.nio.file.Path> consumer,
                                        boolean visitDirectories,
                                        java.lang.String glob)
      • walkFileTree

        public static void walkFileTree​(java.nio.file.Path rootDirectoryPath,
                                        java.util.function.BiConsumer<java.nio.file.Path,​java.nio.file.Path> consumer,
                                        boolean visitDirectories,
                                        java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)
      • createDirectoryReported

        public static void createDirectoryReported​(@Nullable
                                                   @Nullable java.nio.file.Path directoryPath)
      • deleteFileReported

        public static void deleteFileReported​(java.nio.file.Path file)