de.aristaflow.adept2.util

Class FileTools

java.lang.Object

de.aristaflow.adept2.util.FileTools

public final class FileTools
extends java.lang.Object

Utility class containing file-related helper methods, mostly concerning file names and paths.

Author:

Patrick Schmidt

Field Summary

Fields

Modifier and Type	Field and Description
static java.io.FileFilter	CLASS_PATH_ENTRY_FILTER Deprecated. No longer of use when walking file trees via visitor.
static java.lang.String	ILLEGAL_CHARS A string containing characters illegal for file names.

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	addAllEntriesForClassPath(java.io.File file, java.util.List<java.lang.String> classPath, java.util.logging.Logger logger) Deprecated. Use addAllEntriesForClassPath(Path, List, Logger) instead.
static java.util.List<java.lang.String>	addAllEntriesForClassPath(java.nio.file.Path path, java.util.List<java.lang.String> classPath, java.util.logging.Logger logger) Adds all entries making up a classpath (JAR-files and directories) below the designated tree.
static void	cleanDirectory(java.io.File directory) Deprecated. Use deleteTree(Path, boolean) instead.
static <C extends java.io.Closeable> C	close(C closeable) Closes the given Closeable and returns null.
static void	closeQuietly(java.io.Closeable... closeables) Closes the given Closeables, swallowing a potential IOException.
static void	closeQuietly(java.io.Closeable closeable) Closes the given Closeable, swallowing a potential IOException.
static void	copy(java.io.File src, java.io.File dest) Deprecated. Use copy(Path, FilenameFilter, Path, CopyOption...) instead.
static void	copy(java.io.File src, java.io.FilenameFilter filter, java.io.File dest) Deprecated. Use copy(Path, FilenameFilter, Path, CopyOption...) instead.
static void	copy(java.io.File src, java.io.FilenameFilter filter, java.io.File dest, boolean keepExecutable) Deprecated. Use copy(Path, FilenameFilter, Path, CopyOption...) instead.
static void	copy(java.nio.file.Path src, java.io.FilenameFilter filter, java.nio.file.Path dest, java.nio.file.CopyOption... options) Copies the designated source path to the designated destination path.
static void	createFileWithParents(java.nio.file.Path path) Creates the designated file including all parent directories.
static java.io.File	createTempFile(java.io.File parent, java.lang.String child, boolean directory) Creates a new temporary file or directory as child of the designated directory.
static void	delete(java.io.File file) Deprecated. Use deleteTree(Path, boolean) instead.
static boolean	deleteRecursive(java.io.File path) Deprecated. Use deleteTree(Path, boolean) instead.
static boolean	deleteTree(java.nio.file.Path tree, boolean includeRoot) Deletes the designated file path recursively, that is, if it is a directory, its complete contents will be deleted.
static void	fileAccessible(java.io.File file, java.lang.String usedFor) Checks whether the designated file can be accessed (written to).
static java.lang.String	findFileAtDefaultLocation(java.lang.String[] relativePaths, java.lang.String[] absolutePaths) Tries to find one of the given relative or absolute paths and returns the first match.
static java.net.URL[]	getAllEntriesForClassPath(java.io.File file, java.util.logging.Logger logger) Deprecated. Use getAllEntriesForClassPath(Path, Logger) instead.
static java.net.URL[]	getAllEntriesForClassPath(java.nio.file.Path path, java.util.logging.Logger logger) Gets all entries making up a classpath (JAR-files and directories) below the designated tree.
static java.io.File	getDir(java.lang.String path, boolean create) Checks if the designated path directory is a valid directory, it exists or can be created and returns it.
static java.lang.String	getExtension(java.io.File file) Returns the filename's extension, i.e. the characters after the last dot.
static java.lang.String	getExtension(java.lang.String filename) Returns the file's extension, i.e. the characters after the last dot.
static java.io.File	getWithoutExtension(java.io.File file) Returns the given file without the filename extension.
static java.lang.String	getWithoutExtension(java.lang.String path) Returns the given file path without the filename extension.
static boolean	hasExtension(java.io.File file, java.lang.String extension) Tests whether the given file has the given extension.
static java.net.URL	pathPropertyToURL(java.lang.String classPath, java.util.logging.Logger logger) Converts the designated classpath into an URL.
static java.net.URL[]	pathPropertyToURLs(java.util.List<java.lang.String> classPaths, java.util.logging.Logger logger) Converts the designated classpaths into an array of URLs by using pathPropertyToURL(String, Logger).
static java.nio.file.Path	relativise(java.nio.file.Path base, java.nio.file.Path target) Gets the path of target relative to the designated base.
static java.nio.file.Path	relativise(java.lang.String base, java.lang.String target) Gets the path of target relative to the designated base.
static java.lang.String	relativize(java.io.File base, java.io.File file) Deprecated. Use relativise(Path, Path) instead.
static java.lang.String	relativize(java.lang.String base, java.lang.String file) Deprecated. Use relativise(String, String) instead.
static java.lang.String	sanitise(java.lang.String filename, java.lang.String replacement) Sanitises the name of a file (i.e. without any path) by replacing every illegal character with the given string.
static byte[]	toByteArray(java.io.File file) Reads a file into a new byte array.
static void	unzip(java.io.File zipFile, java.io.File targetDir) Unzips the designated zip file to the designated target folder.
static boolean	urlAccessible(java.net.URL url, java.util.logging.Logger logger, boolean write) Checks (more or less reliable) whether the designated URL (directory) exists and can be accessed (for reading and/or writing).

Methods inherited from class java.lang.Object

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

Field Detail

ILLEGAL_CHARS

public static final java.lang.String ILLEGAL_CHARS

A string containing characters illegal for file names. These have been determined on Windows XP and NTFS and should represent a superset of illegal characters across all or at least most OSes.

CLASS_PATH_ENTRY_FILTER

@Deprecated
public static final java.io.FileFilter CLASS_PATH_ENTRY_FILTER

Deprecated. No longer of use when walking file trees via visitor.

File filter used to find elements for the component class path.

Method Detail

getExtension

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

Returns the filename's extension, i.e. the characters after the last dot. This method does not differentiate between "no extension" (the filename contains no dot) and "empty extension" (the dot is the final character in the filename). In both cases the empty string is returned.

Parameters:

file - the file for which to get the extension

Returns:

the filename extension or the empty string

getExtension

public static java.lang.String getExtension(java.lang.String filename)

Returns the file's extension, i.e. the characters after the last dot. This method does not differentiate between "no extension" (the filename contains no dot) and "empty extension" (the dot is the final character in the filename). In both cases the empty string is returned.

Parameters:

filename - the filename for which to get the extension

Returns:

the filename extension or the empty string

hasExtension

public static boolean hasExtension(java.io.File file,
                                   java.lang.String extension)

Tests whether the given file has the given extension. The comparison is done in a case-insensitive way.

Parameters:

file - the file whose extension should be tested

extension - the extension to test for

Returns:

whether the given file has the given extension

getWithoutExtension

public static java.io.File getWithoutExtension(java.io.File file)

Returns the given file without the filename extension.

Parameters:

file - the file from which to remove the extension

Returns:

the given file without the filename extension

getWithoutExtension

public static java.lang.String getWithoutExtension(java.lang.String path)

Returns the given file path without the filename extension.

Parameters:

path - the file path from which to remove the extension

Returns:

the given file path without the filename extension

relativize

@Deprecated
public static java.lang.String relativize(java.lang.String base,
                                                      java.lang.String file)

Deprecated. Use relativise(String, String) instead.

Returns the path of file relative to the given base directory.

Parameters:

base - the base for the relative path

file - the file or directory for which to determine a relative path

Returns:

a relative path so that base + File.separator + relative path denotes file; or null if there is no relative path possible (e.g. on Windows when base and file don't share the same drive letter)

relativize

@Deprecated
public static java.lang.String relativize(java.io.File base,
                                                      java.io.File file)

Deprecated. Use relativise(Path, Path) instead.

Returns the path of file relative to the given base directory.

Parameters:

base - the base for the relative path

file - the file or directory for which to determine a relative path

Returns:

a relative path so that base + File.separator + relative path denotes file; or null if there is no relative path possible (e.g. on Windows when base and file don't share the same drive letter)

relativise

public static java.nio.file.Path relativise(java.lang.String base,
                                            java.lang.String target)

Gets the path of target relative to the designated base. base and target must either both be absolute or both be relative.

Parameters:

base - The path as base for the relative path.

target - The file or directory for which to determine a relative path relative to base.

Returns:

A relative path that resolves against base to target. This will be null if no relative path is possible.

relativise

public static java.nio.file.Path relativise(java.nio.file.Path base,
                                            java.nio.file.Path target)

Gets the path of target relative to the designated base. base and target must either both be absolute or both be relative.

Parameters:

base - The path as base for the relative path.

target - The file or directory for which to determine a relative path relative to base.

Returns:

A relative path that resolves against base to target. This will be null if no relative path is possible.

sanitise

public static java.lang.String sanitise(java.lang.String filename,
                                        java.lang.String replacement)

Sanitises the name of a file (i.e. without any path) by replacing every illegal character with the given string.

Parameters:

filename - the filename to sanitise

replacement - the replacement for illegal characters

Returns:

the sanitised filename

createTempFile

public static java.io.File createTempFile(java.io.File parent,
                                          java.lang.String child,
                                          boolean directory)
                                   throws java.io.IOException

Creates a new temporary file or directory as child of the designated directory. Created files or directories will be deleted on normal exit of the JVM. If a temporary directory already exists, it will be used but it will not be deleted on exit. An existing file will not be used but an IOException will be thrown.

Parameters:

parent - The parent for the directory or file to be created. If this is null, the system temp dir will be used as parent.

child - The name of the temporary directory or file to be created. This must either be one directory or one file. Do not use several directories or a file and one or more directories. If you need this, call this method for each directory and the file.

directory - Whether the temporary file system object is a directory (or a file).

Returns:

The newly created file or directory.

Throws:

java.io.IOException - If the temporary

• directory/file cannot be created,
• directory already exists but it is not a directory,
• file already exists,

an IOException will be thrown.

close

public static <C extends java.io.Closeable> C close(C closeable)
                                             throws java.io.IOException

Closes the given Closeable and returns null.

Type Parameters:

C -

Parameters:

closeable - the Closeable to be closed

Returns:

null

Throws:

java.io.IOException - if Closeable.close() throws an exception

closeQuietly

public static void closeQuietly(java.io.Closeable closeable)

Closes the given Closeable, swallowing a potential IOException.

Parameters:

closeable - the Closeable to be closed; may be null

closeQuietly

public static void closeQuietly(java.io.Closeable... closeables)

Closes the given Closeables, swallowing a potential IOException.

Parameters:

closeables - the Closeables to be closed; may be null

toByteArray

public static byte[] toByteArray(java.io.File file)
                          throws java.io.IOException

Reads a file into a new byte array. Be careful with large files!

Parameters:

file - the file whose content should be loaded into a byte array

Returns:

the file's content in a byte array

Throws:

java.io.IOException - if an I/O error occurs or the file was not found

pathPropertyToURLs

public static java.net.URL[] pathPropertyToURLs(java.util.List<java.lang.String> classPaths,
                                                java.util.logging.Logger logger)

Converts the designated classpaths into an array of URLs by using pathPropertyToURL(String, Logger).

Parameters:

classPaths - The classpaths to add as URLs or relative files.

logger - The logger for log information created by this method.

Returns:

All valid URLs contained in the designated class paths or an empty array in case the designated classpaths are null or empty.

See Also:

URI.isAbsolute()

pathPropertyToURL

public static java.net.URL pathPropertyToURL(java.lang.String classPath,
                                             java.util.logging.Logger logger)

Converts the designated classpath into an URL. An illegal URL is interpreted as local file. From this the canonical name is converted to a URL. If this also fails, the corresponding part of the classpath will be ignored.

For instance, [/C:/Program%20Files/Java/jre1.5.0_07/lib/, /var/lib/security/local_policy.jar, http://aristaflow.de/adept2.jar] is converted to

• file://localhost/C:/Program%20Files/Java/jre1.5.0_07/lib/
• file://localhost/var/lib/security/local_policy.jar
• http://aristaflow.de/adept2.jar

Parameters:

classPath - The classpath to as URL or relative files.

logger - The logger for log information created by this method.

Returns:

A valid URL contained in the designated class path null in case the designated classpath is null or cannot be transformed to an URL.

See Also:

URI.isAbsolute()

getDir

public static java.io.File getDir(java.lang.String path,
                                  boolean create)

Checks if the designated path directory is a valid directory, it exists or can be created and returns it.

• check if actually a string is supplied
• create a File object and check if the file exists (if required)
• check if it is a directory
• create the directory if appropriate

Parameters:

path - The directory to check.

create - Whether to create the directory if it does not exist.

Returns:

The File-instance representing the designated configuration directory or null in case the directory does not exist, cannot be accessed or cannot be created if appropriate.

fileAccessible

public static void fileAccessible(java.io.File file,
                                  java.lang.String usedFor)
                           throws java.io.IOException

Checks whether the designated file can be accessed (written to). If it does not exist, its parent directory is checked for whether the file can be created if required.

Parameters:

file - The file to check for whether it can be accessed (written to).

usedFor - A string providing information for what the file is used for.

Throws:

java.io.IOException - If the designated file cannot be accessed (written to) or cannot be created, an IOException will be thrown.

createFileWithParents

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

Creates the designated file including all parent directories.

Parameters:

path - The file which to create.

Throws:

java.io.IOException - If there are problems creating the file or its parent directories, an IOException will be thrown.

deleteRecursive

@Deprecated
public static boolean deleteRecursive(java.io.File path)
                                           throws java.io.FileNotFoundException

Deprecated. Use deleteTree(Path, boolean) instead.

Deletes the designated file path recursively, that is, if it is a directory, its complete contents will be deleted.

Parameters:

path - The path which to delete recursively.

Returns:

Whether recursive deletion has been completely successful.

Throws:

java.io.FileNotFoundException - If the designated path (or one of its children, for instance when deleting concurrently) is not found, a FileNotFoundException will be thrown.

deleteTree

public static boolean deleteTree(java.nio.file.Path tree,
                                 boolean includeRoot)
                          throws java.io.IOException

Deletes the designated file path recursively, that is, if it is a directory, its complete contents will be deleted. If an exception occurs, deletion will continue and the exception will be thrown at the end.
NOTE: It will not be checked, whether the designated file path exists, therefore using Files.exists(Path, java.nio.file.LinkOption...) prior to this method is recommended.

Parameters:

tree - The tree which to delete recursively.

includeRoot - Whether to also delete the designated tree root.

Returns:

Whether recursive deletion has been completely successful.

Throws:

java.io.IOException - If a problems occurs when deleting the designated tree, an IOException will be thrown.

urlAccessible

public static boolean urlAccessible(java.net.URL url,
                                    java.util.logging.Logger logger,
                                    boolean write)

Checks (more or less reliable) whether the designated URL (directory) exists and can be accessed (for reading and/or writing).

Parameters:

url - The URL to check.

logger - The logger for logging messages related to the accessibility of the designated URL. If this is null, no messages will be logged.

write - Whether the designated URL should also be accessible for writing.

Returns:

Whether the designated URL can be accessed.

getAllEntriesForClassPath

@Deprecated
public static java.net.URL[] getAllEntriesForClassPath(java.io.File file,
                                                                   java.util.logging.Logger logger)

Deprecated. Use getAllEntriesForClassPath(Path, Logger) instead.

Gets all entries making up a classpath (CLASS_PATH_ENTRY_FILTER and directories) below the designated file recursively. This is done in a breadth-first order, that is, all subdirectories are added before their content is added.

Parameters:

file - The file of which to determine all entries making up a classpath.

logger - The logger where problems with accessing a directory will be logged.

Returns:

The classpath with the designated file and all files and directories below it.

getAllEntriesForClassPath

public static java.net.URL[] getAllEntriesForClassPath(java.nio.file.Path path,
                                                       java.util.logging.Logger logger)

Gets all entries making up a classpath (JAR-files and directories) below the designated tree.

Parameters:

path - The tree of which to determine all entries making up a classpath.

logger - The logger where problems with iterating the tree be logged.

Returns:

The classpath with the designated path and all files and directories below it.

addAllEntriesForClassPath

@Deprecated
public static java.util.List<java.lang.String> addAllEntriesForClassPath(java.io.File file,
                                                                                     java.util.List<java.lang.String> classPath,
                                                                                     java.util.logging.Logger logger)

Deprecated. Use addAllEntriesForClassPath(Path, List, Logger) instead.

Adds all entries making up a classpath (CLASS_PATH_ENTRY_FILTER and directories) below the designated file recursively. This is done in a breadth-first order, that is, all subdirectories are added before their content is added.

Parameters:

file - The file of which to determine all entries making up a classpath.

classPath - The classpath determined so far and where to add new classpath entries.

logger - The logger where problems with accessing a directory will be logged.

Returns:

The classpaths where new entries have been added (the very same as the parameter classPath).

addAllEntriesForClassPath

public static java.util.List<java.lang.String> addAllEntriesForClassPath(java.nio.file.Path path,
                                                                         java.util.List<java.lang.String> classPath,
                                                                         java.util.logging.Logger logger)

Adds all entries making up a classpath (JAR-files and directories) below the designated tree. The designated path will not be part of the classpath.

Parameters:

path - The tree of which to determine all entries making up a classpath. This path will not be part of the classpath.

classPath - The classpath where to add new classpath entries.

logger - The logger where problems with iterating the tree be logged.

Returns:

The classpaths where new entries have been added (the very same as the parameter classPath).

findFileAtDefaultLocation

public static java.lang.String findFileAtDefaultLocation(java.lang.String[] relativePaths,
                                                         java.lang.String[] absolutePaths)

Tries to find one of the given relative or absolute paths and returns the first match. Relative paths are relative to the parent of the current working directory and are searched first.

Parameters:

relativePaths - Paths to search for, relative to the parent directory of the current working directory.

absolutePaths - Absolute paths to search for.

Returns:

An absolute paths to the first match

copy

public static void copy(java.nio.file.Path src,
                        java.io.FilenameFilter filter,
                        java.nio.file.Path dest,
                        java.nio.file.CopyOption... options)
                 throws java.io.IOException

Copies the designated source path to the designated destination path. If a file name filter is specified the complete directory tree will be copied but only files accepted by the filter. The target may only be a file in case the source is a file too. If source is a directory it will be copied recursively to the target directory.
Use StandardCopyOptions for replacing files in the destination and/or copying file attributes (e. g. timestamps).

Parameters:

src - The source file or directory which to copy, must not be null.

filter - The filter a file from the source directory needs to match to be copied to the target directory.

dest - The destination file or directory to which to copy, must not be null.

options - The copy options like replacing files in the destination or copying file attributes.

Throws:

java.io.IOException - If there are problems transferring a file, an IOException will be thrown.

copy

@Deprecated
public static void copy(java.io.File src,
                                    java.io.File dest)
                             throws java.io.IOException

Deprecated. Use copy(Path, FilenameFilter, Path, CopyOption...) instead.

Copies the designated file or directory to the designated target. The target may only be a file in case the source is a file too. If source is a directory it will be copied recursively to the target directory.
Note that existing files or directories of the same name will be overwritten.

Parameters:

src - The source file or directory which to copy, must not be null.

dest - The destination file or directory to which to copy, must not be null.

Throws:

java.io.IOException - If there are problems transferring a file, an IOException will be thrown.

See Also:

copy(File, FilenameFilter, File, boolean)

copy

@Deprecated
public static void copy(java.io.File src,
                                    java.io.FilenameFilter filter,
                                    java.io.File dest)
                             throws java.io.IOException

Deprecated. Use copy(Path, FilenameFilter, Path, CopyOption...) instead.

Copies the designated file or directory that match the designated filter to the designated target recursively. If the filter is null all directories and files will be copied. The target may only be a file in case the source is a file too. If source is a directory it will be copied recursively to the target directory.
Note that existing files or directories of the same name will be overwritten.

Parameters:

src - The source file or directory which to copy, must not be null.

filter - The filter a file from the source directory needs to match to be copied to the target directory.

dest - The destination file or directory to which to copy, must not be null.

Throws:

java.io.IOException - If there are problems transferring a file, an IOException will be thrown.

copy

@Deprecated
public static void copy(java.io.File src,
                                    java.io.FilenameFilter filter,
                                    java.io.File dest,
                                    boolean keepExecutable)
                             throws java.io.IOException

Deprecated. Use copy(Path, FilenameFilter, Path, CopyOption...) instead.

Copies the designated file or directory that match the designated filter to the designated target recursively. If the filter is null all directories and files will be copied. The target may only be a file in case the source is a file too. If source is a directory it will be copied recursively to the target directory.
Note that existing files or directories of the same name will be overwritten.

If executable is to be kept and a source file is executable, the corresponding target file will become executable after copying.

Parameters:

src - The source file or directory which to copy, must not be null.

filter - The filter a file from the source directory needs to match to be copied to the target directory.

dest - The destination file or directory to which to copy, must not be null.

keepExecutable - Whether to take over File.canExecute() from the source to the target.

Throws:

java.io.IOException - If there are problems transferring a file, an IOException will be thrown.

delete

@Deprecated
public static void delete(java.io.File file)
                               throws java.io.IOException

Deprecated. Use deleteTree(Path, boolean) instead.

Deletes a file or a directory recursively.

Parameters:

file - The file or directory which to delete.

Throws:

java.io.IOException - If the designated file or directory cannot be deleted, an IOException will be thrown.

cleanDirectory

@Deprecated
public static void cleanDirectory(java.io.File directory)
                                       throws java.io.IOException

Deprecated. Use deleteTree(Path, boolean) instead.

Cleans a directory without deleting it.

Parameters:

directory - directory to clean

Throws:

java.io.IOException - in case cleaning is unsuccessful Inspired by org.apache.commons.io.FileUtils.cleanDirectory(File)

unzip

public static void unzip(java.io.File zipFile,
                         java.io.File targetDir)
                  throws java.io.IOException

Unzips the designated zip file to the designated target folder.

Parameters:

zipFile - The zip file which to unzip.

targetDir - The target folder to which to extract the content of the designated zip file.

Throws:

java.io.IOException - If there are problems reading from the zip file or writing to the target directory or the designated file is a directory or the target directory is a file, an IOException will be thrown.