org.apache.paimon.utils

Class FileIOUtils

java.lang.Object

org.apache.paimon.utils.FileIOUtils

public class FileIOUtils
extends Object

This is a utility class to deal files and directories. Contains utilities for recursive deletion and creation of temporary files.

Constructor Summary

Constructors

Constructor and Description
FileIOUtils()

Method Summary

Modifier and Type	Method and Description
static void	deleteDirectory(File directory) Deletes the given directory recursively.
static void	deleteDirectoryQuietly(File directory) Deletes the given directory recursively, not reporting any I/O exceptions that occur.
static void	deleteFileOrDirectory(File file) Removes the given file or directory recursively.
static byte[]	readAllBytes(Path path) Reads all the bytes from a file.
static String	readFile(File file, String charsetName)
static String	readFileUtf8(File file)
static void	writeCompletely(WritableByteChannel channel, ByteBuffer src)
static void	writeFile(File file, String contents, String encoding)
static void	writeFileUtf8(File file, String contents)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileIOUtils

public FileIOUtils()

Method Detail

writeCompletely

public static void writeCompletely(WritableByteChannel channel,
                                   ByteBuffer src)
                            throws IOException

Throws:

IOException

readFile

public static String readFile(File file,
                              String charsetName)
                       throws IOException

Throws:

IOException

readFileUtf8

public static String readFileUtf8(File file)
                           throws IOException

Throws:

IOException

writeFile

public static void writeFile(File file,
                             String contents,
                             String encoding)
                      throws IOException

Throws:

IOException

writeFileUtf8

public static void writeFileUtf8(File file,
                                 String contents)
                          throws IOException

Throws:

IOException

readAllBytes

public static byte[] readAllBytes(Path path)
                           throws IOException

Reads all the bytes from a file. The method ensures that the file is closed when all bytes have been read or an I/O error, or other runtime exception, is thrown.

This is an implementation that follow Files.readAllBytes(java.nio.file.Path), and the difference is that it limits the size of the direct buffer to avoid direct-buffer OutOfMemoryError. When Files.readAllBytes(java.nio.file.Path) or other interfaces in java API can do this in the future, we should remove it.

Parameters:

path - the path to the file

Returns:

a byte array containing the bytes read from the file

Throws:

IOException - if an I/O error occurs reading from the stream

OutOfMemoryError - if an array of the required size cannot be allocated, for example the file is larger that 2GB

deleteFileOrDirectory

public static void deleteFileOrDirectory(File file)
                                  throws IOException

Removes the given file or directory recursively.

If the file or directory does not exist, this does not throw an exception, but simply does nothing. It considers the fact that a file-to-be-deleted is not present a success.

This method is safe against other concurrent deletion attempts.

Parameters:

file - The file or directory to delete.

Throws:

IOException - Thrown if the directory could not be cleaned for some reason, for example due to missing access/write permissions.

deleteDirectory

public static void deleteDirectory(File directory)
                            throws IOException

Deletes the given directory recursively.

If the directory does not exist, this does not throw an exception, but simply does nothing. It considers the fact that a directory-to-be-deleted is not present a success.

This method is safe against other concurrent deletion attempts.

Parameters:

directory - The directory to be deleted.

Throws:

IOException - Thrown if the given file is not a directory, or if the directory could not be deleted for some reason, for example due to missing access/write permissions.

deleteDirectoryQuietly

public static void deleteDirectoryQuietly(File directory)

Deletes the given directory recursively, not reporting any I/O exceptions that occur.

This method is identical to deleteDirectory(File), except that it swallows all exceptions and may leave the job quietly incomplete.

Parameters:

directory - The directory to delete.