org.macroing.cit.java.io

Class Files2

java.lang.Object

org.macroing.cit.java.io.Files2

public final class Files2
extends java.lang.Object

A class that consists exclusively of static methods that operates on or returns Files.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
static java.io.File	getAbsoluteFile(java.lang.Class<?> clazz) Returns an absolute File, representing the JAR file or the directory in which clazz can be found.
static java.util.List<java.io.File>	getDirectoriesFromDirectory(java.io.File root, java.util.List<java.io.File> directories) Adds all Files that are direct or indirect children to root and file.isDirectory() returns true, to directories, starting from root.
static java.util.List<java.io.File>	getFilesFromDirectory(java.io.File root, java.util.List<java.io.File> files) Adds all Files that are direct or indirect children to root and file.isFile() returns true, to files, starting from root.
static java.io.File	getUserDataDirectoryFor(java.lang.String projectName, java.lang.String projectVersion) Returns a File denoting the user data directory for the given project name and project version.
static java.lang.String	toString(java.io.File file) Returns a String containing the text of the file denoted by file.

Methods inherited from class java.lang.Object

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

Method Detail

getAbsoluteFile

public static java.io.File getAbsoluteFile(java.lang.Class<?> clazz)

Returns an absolute File, representing the JAR file or the directory in which clazz can be found.

If clazz is null, a NullPointerException will be thrown.

If an absolute File cannot be found, an IllegalStateException will be thrown.

Parameters:

clazz - the Class to find the absolute File for

Returns:

an absolute File representing the JAR file or the directory in which clazz can be found

Throws:

java.lang.IllegalStateException - thrown if, and only if, an absolute File cannot be found

java.lang.NullPointerException - thrown if, and only if, clazz is null

getUserDataDirectoryFor

public static java.io.File getUserDataDirectoryFor(java.lang.String projectName,
                                                   java.lang.String projectVersion)

Returns a File denoting the user data directory for the given project name and project version.

If either projectName or projectVersion are null, a NullPointerException will be thrown.

The directory can be located programmatically by the following code, with the assumption that projectName and projectVersion cannot be null.

 
 new File(System.getProperty("user.home") + File.separator + "." + projectName + File.separator + projectVersion)
 
 

Parameters:

projectName - a String with the project name

projectVersion - a String with the project version

Returns:

a File denoting the user data directory for the given project name and project version

Throws:

java.lang.NullPointerException - thrown if, and only if, either projectName or projectVersion are null

getDirectoriesFromDirectory

public static java.util.List<java.io.File> getDirectoriesFromDirectory(java.io.File root,
                                                                       java.util.List<java.io.File> directories)

Adds all Files that are direct or indirect children to root and file.isDirectory() returns true, to directories, starting from root.

Returns directories.

If either root or directories are null, a NullPointerException will be thrown.

If root.isDirectory() returns false, directories will be returned, in its initial state.

Parameters:

root - the root directory

directories - the List to add to and return

Returns:

directories

Throws:

java.lang.NullPointerException - thrown if, and only if, either root or directories are null

getFilesFromDirectory

public static java.util.List<java.io.File> getFilesFromDirectory(java.io.File root,
                                                                 java.util.List<java.io.File> files)

Adds all Files that are direct or indirect children to root and file.isFile() returns true, to files, starting from root.

Returns files.

If either root or files are null, a NullPointerException will be thrown.

If root.isDirectory() returns false, files will be returned, in its initial state.

Parameters:

root - the root directory

files - the List to add to and return

Returns:

files

Throws:

java.lang.NullPointerException - thrown if, and only if, either root or files are null

toString

public static java.lang.String toString(java.io.File file)

Returns a String containing the text of the file denoted by file.

If file is null, a NullPointerException will be thrown.

If the file cannot be read, an UncheckedIOException will be thrown.

Parameters:

file - the File denoting the file to read text from

Returns:

a String containing the text of the file denoted by file

Throws:

java.lang.NullPointerException - thrown if, and only if, file is null

java.io.UncheckedIOException - thrown if, and only if, the file cannot be read