edu.ie3.util.io

Class FileIOUtils

java.lang.Object

edu.ie3.util.io.FileIOUtils

public class FileIOUtils
extends java.lang.Object

Offers some useful features to simplify file handling. Inspired by: https://stackoverflow.com/questions/779519/delete-directories-recursively-in-java/8685959#8685959 and by the linked MyKong Tutorial:

See Also:

MyKong Tutorial

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	CHARSET_UTF8
static java.nio.charset.Charset	CHARSET_WINDOWS_ISO88591
static java.lang.String	NATIVE_NEWLINE

Method Summary

Modifier and Type	Method and Description
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	compressDir(java.nio.file.Path dirName, java.nio.file.Path outputFileName) Compress all the files present in the provided directory and returns a Future with the result.
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	compressFile(java.nio.file.Path fileName, java.nio.file.Path outputFileName) Compresses a single file and returns a Future with the result.
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteFileIfExists(java.lang.String filename) Checks if a file exists and if yes, the file will be deleted and the Future will return true, otherwise it will return false
static void	deleteRecursively(java.nio.file.Path path) Deletes the given path recursively, including the path itself as well
static void	deleteRecursively(java.lang.String path) Deletes the given path described by the path-string recursively, including the path itself as well
static void	extractDir(java.nio.file.Path archive, java.io.File targetDirectory) Extracts the given archive to a sub-directory with the same name that the archive has beneath the target directory.
static java.util.concurrent.CompletableFuture<java.nio.file.Path>	extractDir(java.nio.file.Path archive, java.nio.file.Path target) Extracts the given archive to a sub-directory with the same name that the archive has beneath the target directory.
static java.util.concurrent.CompletableFuture<java.nio.file.Path>	extractFile(java.nio.file.Path zippedFile, java.nio.file.Path target) Extracts the given zipped file to a file with the same name that the zipped file has beneath the target directory.
static java.io.BufferedWriter	getBufferedWriter(java.lang.String filename, java.nio.charset.Charset charset) Tries to open the specified file for writing and returns a BufferedWriter for it.
static java.io.BufferedWriter	getBufferedWriter(java.lang.String filename, java.nio.charset.Charset charset, boolean append) Tries to open the specified file for writing and returns a BufferedWriter for it.
static java.io.BufferedWriter	getBufferedWriterUTF8(java.lang.String filename) Tries to open the specified file for writing and returns a UTF-8 charset encoded BufferedWriter for it.
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	gzip(java.lang.String filename) Deprecated. replaced by #compressFile(Path, Path). Add ".gz" to the input path and pass it as output filepath in compressFile() for a similar functionality.
static java.util.concurrent.CompletableFuture<java.lang.Boolean>	gzip(java.lang.String filename, java.lang.String outputFileName) Deprecated. replaced by #compressFile(Path, Path)

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET_UTF8

public static final java.nio.charset.Charset CHARSET_UTF8

CHARSET_WINDOWS_ISO88591

public static final java.nio.charset.Charset CHARSET_WINDOWS_ISO88591

NATIVE_NEWLINE

public static final java.lang.String NATIVE_NEWLINE

Method Detail

getBufferedWriterUTF8

public static java.io.BufferedWriter getBufferedWriterUTF8(java.lang.String filename)
                                                    throws java.io.IOException

Tries to open the specified file for writing and returns a UTF-8 charset encoded BufferedWriter for it. If the filename ends with ".gz", data will be automatically gzip-compressed.

Parameters:

filename - The filename where to write the data.

Returns:

BufferedWriter for the specified file.

Throws:

java.io.IOException

getBufferedWriter

public static java.io.BufferedWriter getBufferedWriter(java.lang.String filename,
                                                       java.nio.charset.Charset charset)
                                                throws java.io.IOException

Tries to open the specified file for writing and returns a BufferedWriter for it. If the filename ends with ".gz", data will be automatically gzip-compressed.

Parameters:

filename - The filename where to write the data.

charset - the encoding to use to write the file.

Returns:

BufferedWriter for the specified file.

Throws:

java.io.IOException

getBufferedWriter

public static java.io.BufferedWriter getBufferedWriter(java.lang.String filename,
                                                       java.nio.charset.Charset charset,
                                                       boolean append)
                                                throws java.io.IOException

Tries to open the specified file for writing and returns a BufferedWriter for it. If the filename ends with ".gz", data will be automatically gzip-compressed.

Parameters:

filename - filename and path where to write the data e.g. /tmp/out/sample.csv

charset - the required file encoding the while should be written in

append - true if the file should be opened for appending, instead of overwriting - only works if filename doesn't end with .gz

Returns:

BufferedWriter for the specified file

Throws:

java.io.IOException

gzip

@Deprecated
public static java.util.concurrent.CompletableFuture<java.lang.Boolean> gzip(java.lang.String filename)

Deprecated. replaced by #compressFile(Path, Path). Add ".gz" to the input path and pass it as output filepath in compressFile() for a similar functionality.

Compress the provided file (full path + filename required! e.g. /tmp/out/sample.csv) and returns a Future with the result.

Parameters:

filename - the file that should be compress (full path + filename + file extension required!)

Returns:

a Future containing a boolean which is either true on success or false otherwise

gzip

@Deprecated
public static java.util.concurrent.CompletableFuture<java.lang.Boolean> gzip(java.lang.String filename,
                                                                                         java.lang.String outputFileName)

Deprecated. replaced by #compressFile(Path, Path)

Compress the provided file (full path + filename required! e.g. /tmp/out/sample.csv) and returns a Future with the result.

Parameters:

filename - the file that should be compress (full path + filename + file extension required!)

outputFileName - the optional output filename (full path + filename + file extension required!) if different from the provided filename

Returns:

a Future containing a boolean which is either true on success or false otherwise

compressDir

public static java.util.concurrent.CompletableFuture<java.lang.Boolean> compressDir(java.nio.file.Path dirName,
                                                                                    java.nio.file.Path outputFileName)

Compress all the files present in the provided directory and returns a Future with the result.

Parameters:

dirName - path of the directory that should be compressed

outputFileName - path of the output file where the compressed content will be stored (path should be for a file and filename should have a ".tar.gz" extension)

Returns:

a Future containing a boolean which is either true on success or false otherwise

compressFile

public static java.util.concurrent.CompletableFuture<java.lang.Boolean> compressFile(java.nio.file.Path fileName,
                                                                                     java.nio.file.Path outputFileName)

Compresses a single file and returns a Future with the result.

Parameters:

fileName - path of the file that should be compressed

outputFileName - path of the output file where the compressed content will be stored (path should be for a file and filename should have a ".gz" extension)

Returns:

a Future containing a boolean which is either true on success or false otherwise

extractDir

public static java.util.concurrent.CompletableFuture<java.nio.file.Path> extractDir(java.nio.file.Path archive,
                                                                                    java.nio.file.Path target)

Extracts the given archive to a sub-directory with the same name that the archive has beneath the target directory.

Parameters:

archive - Compressed tarball archive to extract

target - Path to the target folder

Returns:

a Future containing a path to the actual folder, where the content is extracted to

extractDir

public static void extractDir(java.nio.file.Path archive,
                              java.io.File targetDirectory)
                       throws FileException

Extracts the given archive to a sub-directory with the same name that the archive has beneath the target directory.

Parameters:

archive - Path of the compressed tarball archive to extract

targetDirectory - File which points to the target directory

Throws:

FileException - If unable to extract the contents of the archive

extractFile

public static java.util.concurrent.CompletableFuture<java.nio.file.Path> extractFile(java.nio.file.Path zippedFile,
                                                                                     java.nio.file.Path target)

Extracts the given zipped file to a file with the same name that the zipped file has beneath the target directory.

Parameters:

zippedFile - Compressed gzip file to extract

target - Path to the target folder

Returns:

a Future containing a path of the file, where the content is extracted to

See Also:

MyKong Tutorial

deleteFileIfExists

public static java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteFileIfExists(java.lang.String filename)

Checks if a file exists and if yes, the file will be deleted and the Future will return true, otherwise it will return false

Parameters:

filename - the file that should be deleted (full path + filename)

Returns:

true if the file has been deleted, false otherwise

deleteRecursively

public static void deleteRecursively(java.lang.String path)
                              throws java.io.IOException

Deletes the given path described by the path-string recursively, including the path itself as well

Parameters:

path - The path to delete

Throws:

java.io.IOException - If something goes wrong.

deleteRecursively

public static void deleteRecursively(java.nio.file.Path path)
                              throws java.io.IOException

Deletes the given path recursively, including the path itself as well

Parameters:

path - The path to delete

Throws:

java.io.IOException - If something goes wrong.