Class FileUtils


  • public final class FileUtils
    extends java.lang.Object
    A utility class to write files.
    Since:
    1.9.0
    • Method Detail

      • newTempFile

        public static FileUtils.TempFile newTempFile()
                                              throws java.io.IOException
        Creates a FileUtils.TempFile instance and backing temporary file on file system. It will be located in the default temporary-file directory. Returned instance should be handled in try-with-resource construct and created temp file is removed (if exists) when returned instance is closed.

        This method uses Files.createTempFile(String, String, java.nio.file.attribute.FileAttribute[]) to create the temporary file on file system.

        Throws:
        java.io.IOException
      • newTempFile

        public static FileUtils.CollocatedTempFile newTempFile​(java.nio.file.Path file)
                                                        throws java.io.IOException
        Creates a FileUtils.CollocatedTempFile instance for given file without backing file. The path will be located in same directory where given file is, and will reuse its name for generated (randomized) name. Returned instance should be handled in try-with-resource and created temp path is removed (if exists) when returned instance is closed. The FileUtils.CollocatedTempFile.move() makes possible to atomically replace passed in file with the processed content written into a file backing the FileUtils.CollocatedTempFile instance.

        The file nor it's parent directories have to exist. The parent directories are created if needed.

        This method uses Path.resolve(String) to create the temporary file path in passed in file parent directory, but it does NOT create backing file on file system.

        Throws:
        java.io.IOException
      • writeFile

        public static void writeFile​(java.nio.file.Path target,
                                     FileUtils.FileWriter writer)
                              throws java.io.IOException
        Writes file without backup.
        Parameters:
        target - that is the target file (must be file, the path must have parent).
        writer - the writer that will accept a Path to write content to.
        Throws:
        java.io.IOException - if at any step IO problem occurs.
      • writeFileWithBackup

        public static void writeFileWithBackup​(java.nio.file.Path target,
                                               FileUtils.FileWriter writer)
                                        throws java.io.IOException
        Writes file with backup copy (appends ".bak" extension).
        Parameters:
        target - that is the target file (must be file, the path must have parent).
        writer - the writer that will accept a Path to write content to.
        Throws:
        java.io.IOException - if at any step IO problem occurs.