de.gerdiproject.harvest.utils.file

Class FileUtils

java.lang.Object

de.gerdiproject.harvest.utils.file.FileUtils

public class FileUtils
extends Object

A small class with helper functions that are used for file operations.

Author:

Robin Weiss

Method Summary

Modifier and Type	Method and Description
static void	copyFile(File sourceFile, File targetFile) Copies a single file to a target destination and logs any errors.
static boolean	createDirectories(File directory) Attempts to create all directories of a given directory path.
static void	createEmptyFile(File file) Creates a new cache file, replacing any file that already exists.
static void	deleteFile(File deletedFile) Attempts to delete a file from disk if it exists and logs any errors.
static BufferedReader	getReader(File file, Charset charset) Opens an InputStream to a specified file and wraps it in a BufferedReader using a specified Charset.
static BufferedReader	getReader(String filePath, Charset charset) Opens an InputStream to a specified file and wraps it in a BufferedReader using a specified Charset.
static BufferedWriter	getWriter(File file, Charset charset) Opens an OutputStream to a specified file and wraps it in a BufferedWriter using a specified Charset.
static BufferedWriter	getWriter(String filePath, Charset charset) Opens an OutputStream to a specified file and wraps it in a BufferedWriter using a specified Charset.
static void	integrateDirectory(File sourceDirectory, File targetDirectory, boolean replaceFiles) Merges one directory into another one.
static void	replaceFile(File targetFile, File newFile) Replaces one file with another and logs any errors.

Methods inherited from class java.lang.Object

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

Method Detail

deleteFile

public static void deleteFile(File deletedFile)

Attempts to delete a file from disk if it exists and logs any errors.

Parameters:

deletedFile - the file that is to be deleted

replaceFile

public static void replaceFile(File targetFile,
                               File newFile)

Replaces one file with another and logs any errors.

Parameters:

targetFile - the file that is to be replaced

newFile - the new file that replaces the target file

copyFile

public static void copyFile(File sourceFile,
                            File targetFile)

Copies a single file to a target destination and logs any errors.

Parameters:

sourceFile - the file that is to be copied

targetFile - the destination file

createDirectories

public static boolean createDirectories(File directory)

Attempts to create all directories of a given directory path.

Parameters:

directory - the directory path to be created

Returns:

true if the directories already exist or were created

createEmptyFile

public static void createEmptyFile(File file)

Creates a new cache file, replacing any file that already exists.

Parameters:

file - the file that is to be created

integrateDirectory

public static void integrateDirectory(File sourceDirectory,
                                      File targetDirectory,
                                      boolean replaceFiles)

Merges one directory into another one.

Parameters:

sourceDirectory - the directory that is to be integrated

targetDirectory - the directory into which the other folder is merged

replaceFiles - if true, sourceDirectory files with the same name as in the target directory, will be replaced

getReader

public static BufferedReader getReader(String filePath,
                                       Charset charset)
                                throws IOException

Opens an InputStream to a specified file and wraps it in a BufferedReader using a specified Charset.

Parameters:

filePath - the path to the file that is to be read

charset - the charset used to parse the file

Returns:

a BufferedReader that reads the file content

Throws:

IOException - if the file cannot be read

getReader

public static BufferedReader getReader(File file,
                                       Charset charset)
                                throws IOException

Opens an InputStream to a specified file and wraps it in a BufferedReader using a specified Charset.

Parameters:

file - the file that is to be read

charset - the charset used to parse the file

Returns:

a BufferedReader that reads the file content

Throws:

IOException - if the file cannot be read

getWriter

public static BufferedWriter getWriter(String filePath,
                                       Charset charset)
                                throws IOException

Opens an OutputStream to a specified file and wraps it in a BufferedWriter using a specified Charset.

Parameters:

filePath - the path to the file that is to be written to

charset - the charset used to write to the file

Returns:

a BufferedWriter that can write to the file

Throws:

IOException - if the file cannot be read or written to

getWriter

public static BufferedWriter getWriter(File file,
                                       Charset charset)
                                throws IOException

Opens an OutputStream to a specified file and wraps it in a BufferedWriter using a specified Charset.

Parameters:

file - the file that is to be written to

charset - the charset used to write to the file

Returns:

a BufferedWriter that can write to the file

Throws:

IOException - if the file cannot be read or written to