ai.libs.jaicore.basic

Class FileUtil

java.lang.Object

ai.libs.jaicore.basic.FileUtil

public class FileUtil
extends java.lang.Object

Util class for handling file I/O.

Method Summary

Modifier and Type	Method and Description
static void	deleteFolderRecursively(java.io.File dir)
static java.io.File	getExistingFileWithHighestPriority(java.lang.String resourcePath, java.lang.String... fileSystemPaths) Returns the file for a given path with the highest priority which also exists; the resource path is the backup solution with lowest priority.
static java.util.List<java.io.File>	getFilesOfFolder(java.io.File folder)
static boolean	move(java.io.File from, java.io.File to)
static void	move(java.lang.String from, java.lang.String to)
static java.util.List<java.lang.String>	readFileAsList(java.io.File file)
static java.util.List<java.lang.String>	readFileAsList(java.lang.String filename)
static java.util.List<java.util.List<java.lang.String>>	readFileAsMatrix(java.lang.String filename, java.lang.String separation)
static java.lang.String	readFileAsString(java.io.File file)
static java.lang.String	readFileAsString(java.lang.String filename)
static java.util.Properties	readPropertiesFile(java.io.File propertiesFile)
static void	requireFileExists(java.io.File file) Checks whetehr a given file exists and if so, whether it is actually a file and not a directory.
static void	serializeObject(java.lang.Object object, java.lang.String pathname)
static void	touch(java.lang.String filename)
static java.lang.Object	unserializeObject(java.lang.String pathname)
static void	zipFiles(java.util.Collection<java.lang.String> files, java.lang.String archive)

Methods inherited from class java.lang.Object

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

Method Detail

readFileAsList

public static java.util.List<java.lang.String> readFileAsList(java.io.File file)
                                                       throws java.io.IOException

Throws:

java.io.IOException

readFileAsList

public static java.util.List<java.lang.String> readFileAsList(java.lang.String filename)
                                                       throws java.io.IOException

Throws:

java.io.IOException

readFileAsString

public static java.lang.String readFileAsString(java.io.File file)
                                         throws java.io.IOException

Throws:

java.io.IOException

readFileAsString

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

Throws:

java.io.IOException

readFileAsMatrix

public static java.util.List<java.util.List<java.lang.String>> readFileAsMatrix(java.lang.String filename,
                                                                                java.lang.String separation)
                                                                         throws java.io.IOException

Throws:

java.io.IOException

deleteFolderRecursively

public static void deleteFolderRecursively(java.io.File dir)
                                    throws java.io.IOException

Throws:

java.io.IOException

zipFiles

public static void zipFiles(java.util.Collection<java.lang.String> files,
                            java.lang.String archive)
                     throws java.io.FileNotFoundException,
                            java.io.IOException

Throws:

java.io.FileNotFoundException

java.io.IOException

serializeObject

public static void serializeObject(java.lang.Object object,
                                   java.lang.String pathname)
                            throws java.io.IOException

Throws:

java.io.IOException

unserializeObject

public static java.lang.Object unserializeObject(java.lang.String pathname)
                                          throws java.io.IOException,
                                                 java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

touch

public static void touch(java.lang.String filename)

move

public static boolean move(java.io.File from,
                           java.io.File to)

move

public static void move(java.lang.String from,
                        java.lang.String to)

getFilesOfFolder

public static java.util.List<java.io.File> getFilesOfFolder(java.io.File folder)

readPropertiesFile

public static java.util.Properties readPropertiesFile(java.io.File propertiesFile)
                                               throws java.io.IOException

Throws:

java.io.IOException

requireFileExists

public static void requireFileExists(java.io.File file)
                              throws FileIsDirectoryException,
                                     java.io.FileNotFoundException

Checks whetehr a given file exists and if so, whether it is actually a file and not a directory.

Parameters:

file - The file to be checked.

Throws:

FileIsDirectoryException - Is thrown if the file exists but is a directory.

java.io.FileNotFoundException - Is thrown if there exists no such file.

getExistingFileWithHighestPriority

public static java.io.File getExistingFileWithHighestPriority(java.lang.String resourcePath,
                                                              java.lang.String... fileSystemPaths)

Returns the file for a given path with the highest priority which also exists; the resource path is the backup solution with lowest priority. The getter iterates over the fileSytemPaths array and returns the first existing file, i.e. paths with a lower array index have higher priority. If there is no element in the array or none of the given paths exists as a file, the file corresponding to the resource path will be returned as a fall-back, i.e., the resource path has the lowest priority.

Parameters:

resourcePath - The resource path that is to be taken as a fall-back.

fileSystemPaths - An array of paths with descending priority.

Returns:

The existing file with highest priority.