org.apache.flink.util

Class FileUtils

java.lang.Object

org.apache.flink.util.FileUtils

public final class FileUtils
extends Object

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

Method Summary

Modifier and Type	Method and Description
static void	cleanDirectory(File directory) Removes all files contained within a directory, without removing the directory itself.
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 boolean	deletePathIfEmpty(FileSystem fileSystem, Path path) Deletes the path if it is empty.
static String	getRandomFilename(String prefix) Constructs a random filename with the given prefix and a random part generated from hex characters.
static String	readFile(File file, String charsetName)
static String	readFileUtf8(File file)
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

Method Detail

getRandomFilename

public static String getRandomFilename(String prefix)

Constructs a random filename with the given prefix and a random part generated from hex characters.

Parameters:

prefix - the prefix to the filename to be constructed

Returns:

the generated random filename with the given prefix

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

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.

cleanDirectory

public static void cleanDirectory(File directory)
                           throws IOException

Removes all files contained within a directory, without removing the directory itself.

This method is safe against other concurrent deletion attempts.

Parameters:

directory - The directory to remove all files from.

Throws:

FileNotFoundException - Thrown if the directory itself does not exist.

IOException - Thrown if the file indicates a proper file and not a directory, or if the directory could not be cleaned for some reason, for example due to missing access/write permissions.

deletePathIfEmpty

public static boolean deletePathIfEmpty(FileSystem fileSystem,
                                        Path path)
                                 throws IOException

Deletes the path if it is empty. A path can only be empty if it is a directory which does not contain any other directories/files.

Parameters:

fileSystem - to use

path - to be deleted if empty

Returns:

true if the path could be deleted; otherwise false

Throws:

IOException - if the delete operation fails