org.conqat.lib.commons.filesystem

Class FileSystemUtils

java.lang.Object

org.conqat.lib.commons.filesystem.FileSystemUtils

public class FileSystemUtils
extends java.lang.Object

File system utilities.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METRIC_SYSTEM_UNITS String containing the unit letters for units in the metric system (K for kilo, M for mega, ...).
static java.lang.String	TEMP_DIR_PATH The path to the directory used by Java to store temporary files
static char	UNIX_SEPARATOR Unix file path separator
static java.lang.String	UTF8_ENCODING Encoding for UTF-8.
static char	WINDOWS_SEPARATOR Windows file path separator

Constructor Summary

Constructors

Constructor and Description
FileSystemUtils()

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	autoDecompressStream(java.io.InputStream in) Transparently creates a stream for decompression if the provided stream is compressed.
static void	close(java.io.Closeable closeable) Convenience method for calling close(Closeable, ILogger) with a null-logger.
static void	close(java.io.Closeable closeable, ILogger logger) This method can be used to simplify the typical finally -block of code dealing with streams and readers/writers.
static void	close(ZipFile zipFile) Closes the given ZIP file quietly, i.e.
static java.io.File	commonRoot(java.lang.Iterable<? extends java.io.File> files) Determines the root directory from a collection of files.
static java.lang.String	concatenatePaths(java.lang.String firstParent, java.lang.String... paths) Concatenates all path parts into a single path with normalized separators.
static boolean	contentsEqual(java.io.File file1, java.io.File file2) Checks whether two files have the same content.
static int	copy(java.io.InputStream input, java.io.OutputStream output) Copy an input stream to an output stream.
static void	copyFile(java.io.File sourceFile, java.io.File targetFile) Copy a file.
static void	copyFile(java.lang.String sourceFilename, java.lang.String targetFilename) Copy a file.
static int	copyFiles(java.io.File sourceDirectory, java.io.File targetDirectory, java.io.FileFilter fileFilter) Copy all files specified by a file filter from one directory to another.
static int	createJARFile(java.io.File jarFile, java.io.File sourceDirectory, java.io.FileFilter filter) Create jar file from all files in a directory.
static java.lang.String	createRelativePath(java.io.File path, java.io.File relativeTo) Returns a string describing the relative path to the given directory.
static void	deleteFile(java.io.File file) Deletes the given file and throws an exception if this fails.
static void	deleteRecursively(java.io.File directory) Recursively delete directories and files.
static void	ensureDirectoryExists(java.io.File directory) Checks if a directory exists.
static void	ensureParentDirectoryExists(java.io.File file) Checks if the parent directory of a file exists.
static java.io.File	escapeReservedFileNames(java.io.File file) Returns a new file with all file path segments that are reserved (windows) path names escaped.
static java.io.File	extractJarFileFromJarURL(java.net.URL url) Returns the JAR file for an URL with protocol 'jar'.
static java.lang.String	getFileExtension(java.io.File file) Returns the extension of the file.
static java.lang.String	getFileExtension(java.lang.String path) Returns the extension of the file at the given path.
static java.lang.String	getFilenameWithoutExtension(java.io.File file) Returns the name of the given file without extension.
static java.lang.String	getFilenameWithoutExtension(java.lang.String fileName) Returns the name of the given file without extension.
static long	getLastModifiedTimestamp(java.io.File file) Determines the last modified timestamp in a platform agnostic way.
static java.lang.String	getLastPathSegment(java.lang.String filePath) Returns the last path segment (i.e.
static java.io.File	getNonExistingFile(java.io.File file) Returns a file that does not exist in the same directory of the given file.
static java.lang.String[]	getPathSegments(java.lang.String filePath) Returns the segments of a path.
static java.io.File	getTmpDir() Obtains the system's temporary directory
static java.io.File	getUserHomeDir() Obtains the current user's home directory
static java.io.File	getWorkspaceDir() Obtains the current working directory.
static boolean	isAbsolutePath(java.lang.String filename) Returns whether a filename represents an absolute path.
static boolean	isReadableFile(java.io.File... files) Returns whether the given file is non-null, a plain file and is readable.
static java.util.List<java.lang.String>	listFilesInSameLocationForURL(java.net.URL baseUrl)
static java.util.List<java.lang.String>	listFilesInSameLocationForURL(java.net.URL baseUrl, boolean includeSubfolders) Lists the names of all simple files (i.e.
static java.util.List<java.io.File>	listFilesRecursively(java.io.File directory) Returns a list of all files and directories contained in the given directory and all subdirectories.
static java.util.List<java.io.File>	listFilesRecursively(java.io.File directory, java.io.FileFilter filter) Returns a list of all files and directories contained in the given directory and all subdirectories matching the filter provided.
static java.util.List<java.lang.String>	listTopLevelClassesInJarFile(java.io.File jarFile) Extract all top-level classes in the given JAR and returns a list of their fully qualified class names.
static void	mergeTemplate(java.io.File templateFile, java.io.File outFile, java.lang.Object... arguments) Loads template file with a Format string, formats it and writes result to file.
static java.io.InputStream	mergeTemplate(java.io.InputStream inStream, java.lang.Object... arguments) Loads template file with a Format string, formats it and provides result as stream.
static void	mkdir(java.io.File dir) Creates a directory and throws an exception if this fails.
static void	mkdirs(java.io.File dir) Creates a directory and all required parent directories.
static java.io.File	newFile(java.io.File parentFile, java.lang.String... pathElements) Constructs a file from a base file by appending several path elements.
static java.lang.String	normalizeSeparators(java.lang.String path) Replace platform dependent separator char with forward slashes to create system-independent paths.
static java.io.InputStream	openJarFileEntry(java.util.jar.JarFile jarFile, java.lang.String entryName) Opens an InputStream for the entry with the given name in the given JAR file
static long	parseDataSize(java.lang.String dataSize) Converts the given human readable data size to the corresponding number of bytes.
static java.lang.String	readFile(java.io.File file) Read file content into a string using the default encoding for the platform.
static java.lang.String	readFile(java.io.File file, java.nio.charset.Charset encoding) Read file content into a string using the given encoding.
static byte[]	readFileBinary(java.io.File file) Read file content into a byte array.
static byte[]	readFileBinary(java.lang.String filePath) Read file content into a byte array.
static java.lang.String	readFileSystemIndependent(java.io.File file) Reads a file using UTF-8 encoding and normalizes line breaks (replacing "\n\r" and "\r" with "\n").
static java.lang.String	readFileUTF8(java.io.File file) Read file content into a string using UTF-8 encoding.
static java.lang.String	readFileUTF8WithLineBreakNormalization(java.io.File file) Read file content into a string using UTF-8 encoding and normalize the line breaks.
static java.util.List<java.lang.String>	readLines(java.io.File file, java.nio.charset.Charset encoding) Read file content into a list of lines (strings) using the given encoding.
static java.util.List<java.lang.String>	readLinesUTF8(java.io.File file) Read file content into a list of lines (strings) using UTF-8 encoding.
static java.util.List<java.lang.String>	readLinesUTF8(java.lang.String filePath) Read file content into a list of lines (strings) using UTF-8 encoding.
static java.util.Properties	readProperties(CollectionUtils.SupplierWithException<? extends java.io.InputStream,java.io.IOException> streamSupplier) Reads properties from a properties stream.
static java.util.Properties	readProperties(java.io.File propertiesFile) Reads properties from a properties file.
static java.util.Properties	readProperties(Resource resource) Reads properties from a properties resource.
static java.lang.String	readStream(java.io.InputStream input) Read input stream into string.
static java.lang.String	readStream(java.io.InputStream input, java.nio.charset.Charset encoding) Read input stream into string.
static byte[]	readStreamBinary(java.io.InputStream input) Read input stream into raw byte array.
static java.lang.String	readStreamUTF8(java.io.InputStream input) Read input stream into string.
static void	recursivelyRemoveDirectoryIfEmpty(java.io.File path) Removes the given path if it is an empty directory and recursively parent directories if the only child was deleted.
static void	renameFileTo(java.io.File file, java.io.File dest) Renames the given file and throws an exception if this fails.
static java.lang.String	replaceFilePathFilenameWith(java.lang.String uniformPath, java.lang.String newFileName) Replaces the file name of the given path with the given new extension.
static void	safeRead(java.io.InputStream in, byte[] data) Reads bytes of data from the input stream into an array of bytes until the array is full.
static void	safeRead(java.io.InputStream in, byte[] data, int offset, int length) Reads length bytes of data from the input stream into an array of bytes and stores it at position offset.
static void	sort(java.util.List<java.io.File> files) Compares files based on the lexical order of their fully qualified names.
static java.io.Reader	streamReader(java.io.InputStream in, java.nio.charset.Charset encoding) Returns a reader that wraps the given input stream.
static java.lang.String	toSafeFilename(java.lang.String name) Returns a safe filename that can be used for downloads.
static void	unjar(java.io.File jarFile, java.io.File targetDirectory) Extract a JAR file to a directory.
static void	unzip(java.io.File zipFile, java.io.File targetDirectory) Extract a ZIP file to a directory.
static java.util.List<java.lang.String>	unzip(java.io.File zipFile, java.io.File targetDirectory, java.lang.String prefix, java.nio.charset.Charset charset) Extract the entries of ZIP file to a directory.
static java.util.List<java.lang.String>	unzip(java.io.InputStream inputStream, java.io.File targetDirectory) Extract entries of a zip file input stream to a directory.
static java.util.List<java.lang.String>	unzip(ZipFile zip, java.io.File targetDirectory, java.lang.String prefix) Extract entries of a ZipFile to a directory when the ZipFile is created externally.
static void	writeFile(java.io.File file, java.lang.String content) Write string to a file with the default encoding.
static void	writeFile(java.io.File file, java.lang.String content, java.lang.String encoding) Write string to a file.
static void	writeFileBinary(java.io.File file, byte[] bytes) Writes the given bytes to the given file.
static void	writeFileUTF8(java.io.File file, java.lang.String content) Write string to a file with UTF8 encoding.
static void	writeFileWithBOM(java.io.File file, java.lang.String content, EByteOrderMark bom) Write string to a file using a UTF encoding.
static void	writeLines(java.io.File file, java.util.Collection<java.lang.String> lines) Writes the given collection of String as lines into the specified file.

Methods inherited from class java.lang.Object

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

Field Detail

UTF8_ENCODING

public static final java.lang.String UTF8_ENCODING

Encoding for UTF-8.

TEMP_DIR_PATH

public static final java.lang.String TEMP_DIR_PATH

The path to the directory used by Java to store temporary files

UNIX_SEPARATOR

public static final char UNIX_SEPARATOR

Unix file path separator

See Also:

Constant Field Values

WINDOWS_SEPARATOR

public static final char WINDOWS_SEPARATOR

Windows file path separator

See Also:

Constant Field Values

METRIC_SYSTEM_UNITS

public static final java.lang.String METRIC_SYSTEM_UNITS

String containing the unit letters for units in the metric system (K for kilo, M for mega, ...). Ordered by their power value (the order is important).

See Also:

Constant Field Values

Constructor Detail

FileSystemUtils

public FileSystemUtils()

Method Detail

copy

public static int copy(java.io.InputStream input,
                       java.io.OutputStream output)
                throws java.io.IOException

Copy an input stream to an output stream. This does not close the streams.

Parameters:

input - input stream

output - output stream

Returns:

number of bytes copied

Throws:

java.io.IOException - if an IO exception occurs.

copyFile

public static void copyFile(java.io.File sourceFile,
                            java.io.File targetFile)
                     throws java.io.IOException

Copy a file. This creates all necessary directories.

Throws:

java.io.IOException

copyFile

public static void copyFile(java.lang.String sourceFilename,
                            java.lang.String targetFilename)
                     throws java.io.IOException

Copy a file. This creates all necessary directories.

Throws:

java.io.IOException

copyFiles

public static int copyFiles(java.io.File sourceDirectory,
                            java.io.File targetDirectory,
                            java.io.FileFilter fileFilter)
                     throws java.io.IOException

Copy all files specified by a file filter from one directory to another. This automatically creates all necessary directories.

Parameters:

fileFilter - filter to specify file types. If all files should be copied, use FileOnlyFilter.

Returns:

number of files copied

Throws:

java.io.IOException

createJARFile

public static int createJARFile(java.io.File jarFile,
                                java.io.File sourceDirectory,
                                java.io.FileFilter filter)
                         throws java.io.IOException

Create jar file from all files in a directory.

Parameters:

filter - filter to specify file types. If all files should be copied, use FileOnlyFilter.

Returns:

number of files added to the jar file

Throws:

java.io.IOException

createRelativePath

public static java.lang.String createRelativePath(java.io.File path,
                                                  java.io.File relativeTo)
                                           throws java.io.IOException

Returns a string describing the relative path to the given directory. If there is no relative path, as the directories do not share a common parent, the absolute path is returned.

Parameters:

path - the path to convert to a relative path (must describe an existing directory)

relativeTo - the anchor (must describe an existing directory)

Returns:

a relative path

Throws:

java.io.IOException - if creation of canonical pathes fails.

deleteRecursively

public static void deleteRecursively(java.io.File directory)

Recursively delete directories and files. This method ignores the return value of delete(), i.e. if anything fails, some files might still exist.

deleteFile

public static void deleteFile(java.io.File file)
                       throws java.io.IOException

Deletes the given file and throws an exception if this fails.

Throws:

java.io.IOException

See Also:

File.delete()

renameFileTo

public static void renameFileTo(java.io.File file,
                                java.io.File dest)
                         throws java.io.IOException

Renames the given file and throws an exception if this fails.

Throws:

java.io.IOException

See Also:

File.renameTo(File)

mkdir

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

Creates a directory and throws an exception if this fails.

Throws:

java.io.IOException

See Also:

File.mkdir()

mkdirs

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

Creates a directory and all required parent directories. Throws an exception if this fails.

Throws:

java.io.IOException

See Also:

File.mkdirs()

ensureDirectoryExists

public static void ensureDirectoryExists(java.io.File directory)
                                  throws java.io.IOException

Checks if a directory exists. If not it creates the directory and all necessary parent directories.

Throws:

java.io.IOException - if directories couldn't be created.

ensureParentDirectoryExists

public static void ensureParentDirectoryExists(java.io.File file)
                                        throws java.io.IOException

Checks if the parent directory of a file exists. If not it creates the directory and all necessary parent directories.

Throws:

java.io.IOException - if directories couldn't be created.

listFilesRecursively

public static java.util.List<java.io.File> listFilesRecursively(java.io.File directory)

Returns a list of all files and directories contained in the given directory and all subdirectories. The given directory itself is not included in the result.

This method knows nothing about (symbolic and hard) links, so care should be taken when traversing directories containing recursive links.

Parameters:

directory - the directory to start the search from.

Returns:

the list of files found (the order is determined by the file system).

listFilesRecursively

public static java.util.List<java.io.File> listFilesRecursively(java.io.File directory,
                                                                java.io.FileFilter filter)

Returns a list of all files and directories contained in the given directory and all subdirectories matching the filter provided. The given directory itself is not included in the result.

The file filter may or may not exclude directories.

This method knows nothing about (symbolic and hard) links, so care should be taken when traversing directories containing recursive links.

Parameters:

directory - the directory to start the search from. If this is null or the directory does not exist, an empty list is returned.

filter - the filter used to determine whether the result should be included. If the filter is null, all files and directories are included.

Returns:

the list of files found (the order is determined by the file system).

listFilesInSameLocationForURL

public static java.util.List<java.lang.String> listFilesInSameLocationForURL(java.net.URL baseUrl)
                                                                      throws java.io.IOException

Throws:

java.io.IOException

See Also:

listFilesInSameLocationForURL(URL, boolean)

listFilesInSameLocationForURL

public static java.util.List<java.lang.String> listFilesInSameLocationForURL(java.net.URL baseUrl,
                                                                             boolean includeSubfolders)
                                                                      throws java.io.IOException

Lists the names of all simple files (i.e. no directories) next to an URL. For example for a file, this would return the names of all files in the same directory (including the file itself). Currently, this supports both file and jar URLs. The intended use-case is to list a set of files in a package via the class loader.

Throws:

java.io.IOException

listTopLevelClassesInJarFile

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

Extract all top-level classes in the given JAR and returns a list of their fully qualified class names. Inner classes are ignored.

Throws:

java.io.IOException

getFileExtension

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

Returns the extension of the file.

Returns:

File extension, i.e. "java" for "FileSystemUtils.java", or null, if the file has no extension (i.e. if a filename contains no '.'), returns the empty string if the '.' is the filename's last character.

getFileExtension

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

Returns the extension of the file at the given path.

getFilenameWithoutExtension

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

Returns the name of the given file without extension. Example: '/home/joe/data.dat' -> 'data'.

getFilenameWithoutExtension

public static java.lang.String getFilenameWithoutExtension(java.lang.String fileName)

Returns the name of the given file without extension. Example: 'data.dat' -> 'data'.

getLastPathSegment

public static java.lang.String getLastPathSegment(java.lang.String filePath)

Returns the last path segment (i.e. file name or folder name) of a file path.

getPathSegments

public static java.lang.String[] getPathSegments(java.lang.String filePath)

Returns the segments of a path.

newFile

public static java.io.File newFile(java.io.File parentFile,
                                   java.lang.String... pathElements)

Constructs a file from a base file by appending several path elements. Insertion of separators is performed automatically as needed. This is similar to the constructor File.File(File, String) but allows to define multiple child levels.

Parameters:

pathElements - list of elements. If this is empty, the parent is returned.

Returns:

the new file.

readFile

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

Read file content into a string using the default encoding for the platform. If the file starts with a UTF byte order mark (BOM), the encoding is ignored and the correct encoding based on this BOM is used for reading the file.

Throws:

java.io.IOException

See Also:

EByteOrderMark

readFileUTF8

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

Read file content into a string using UTF-8 encoding. If the file starts with a UTF byte order mark (BOM), the encoding is ignored and the correct encoding based on this BOM is used for reading the file.

Throws:

java.io.IOException

See Also:

EByteOrderMark

readFileUTF8WithLineBreakNormalization

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

Read file content into a string using UTF-8 encoding and normalize the line breaks. If the file starts with a UTF byte order mark (BOM), the encoding is ignored and the correct encoding based on this BOM is used for reading the file.

Throws:

java.io.IOException

See Also:

EByteOrderMark, StringUtils.normalizeLineSeparatorsPlatformSpecific(String)

readFile

public static java.lang.String readFile(java.io.File file,
                                        java.nio.charset.Charset encoding)
                                 throws java.io.IOException

Read file content into a string using the given encoding. If the file starts with a UTF byte order mark (BOM), the encoding is ignored and the correct encoding based on this BOM is used for reading the file.

Throws:

java.io.IOException

See Also:

EByteOrderMark

readLines

public static java.util.List<java.lang.String> readLines(java.io.File file,
                                                         java.nio.charset.Charset encoding)
                                                  throws java.io.IOException

Read file content into a list of lines (strings) using the given encoding. This uses automatic BOM handling, just as readFile(File).

Throws:

java.io.IOException

readLinesUTF8

public static java.util.List<java.lang.String> readLinesUTF8(java.lang.String filePath)
                                                      throws java.io.IOException

Read file content into a list of lines (strings) using UTF-8 encoding. This uses automatic BOM handling, just as readFile(File).

Throws:

java.io.IOException

readLinesUTF8

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

Read file content into a list of lines (strings) using UTF-8 encoding. This uses automatic BOM handling, just as readFile(File).

Throws:

java.io.IOException

readFileBinary

public static byte[] readFileBinary(java.lang.String filePath)
                             throws java.io.IOException

Read file content into a byte array.

Throws:

java.io.IOException

readFileBinary

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

Read file content into a byte array.

Throws:

java.io.IOException

unjar

public static void unjar(java.io.File jarFile,
                         java.io.File targetDirectory)
                  throws java.io.IOException

Extract a JAR file to a directory.

Throws:

java.io.IOException

unzip

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

Extract a ZIP file to a directory.

Throws:

java.io.IOException

unzip

public static java.util.List<java.lang.String> unzip(java.io.File zipFile,
                                                     java.io.File targetDirectory,
                                                     java.lang.String prefix,
                                                     java.nio.charset.Charset charset)
                                              throws java.io.IOException

Extract the entries of ZIP file to a directory.

Parameters:

prefix - Sets a prefix for the the entry names (paths) which should be extracted. Only entries which starts with the given prefix are extracted. If prefix is null or empty all entries are extracted. The prefix will be stripped form the extracted entries.

charset - defines the Charset of the ZIP file. If null, the standard of ZipFile is used (which is UTF-8).

Returns:

list of the extracted paths

Throws:

java.io.IOException

unzip

public static java.util.List<java.lang.String> unzip(ZipFile zip,
                                                     java.io.File targetDirectory,
                                                     java.lang.String prefix)
                                              throws java.io.IOException

Extract entries of a ZipFile to a directory when the ZipFile is created externally. Note that this does not close the ZipFile, so the caller has to take care of this.

Throws:

java.io.IOException

unzip

public static java.util.List<java.lang.String> unzip(java.io.InputStream inputStream,
                                                     java.io.File targetDirectory)
                                              throws java.io.IOException

Extract entries of a zip file input stream to a directory. The input stream is automatically closed by this method.

Throws:

java.io.IOException

writeFile

public static void writeFile(java.io.File file,
                             java.lang.String content)
                      throws java.io.IOException

Write string to a file with the default encoding. This ensures all directories exist.

Throws:

java.io.IOException

writeLines

public static void writeLines(java.io.File file,
                              java.util.Collection<java.lang.String> lines)
                       throws java.io.IOException

Writes the given collection of String as lines into the specified file. This method uses \n as a line separator.

Throws:

java.io.IOException

writeFileUTF8

public static void writeFileUTF8(java.io.File file,
                                 java.lang.String content)
                          throws java.io.IOException

Write string to a file with UTF8 encoding. This ensures all directories exist.

Throws:

java.io.IOException

writeFile

public static void writeFile(java.io.File file,
                             java.lang.String content,
                             java.lang.String encoding)
                      throws java.io.IOException

Write string to a file. This ensures all directories exist.

Throws:

java.io.IOException

writeFileWithBOM

public static void writeFileWithBOM(java.io.File file,
                                    java.lang.String content,
                                    EByteOrderMark bom)
                             throws java.io.IOException

Write string to a file using a UTF encoding. The file will be prefixed with a byte-order mark. This ensures all directories exist.

Throws:

java.io.IOException

writeFileBinary

public static void writeFileBinary(java.io.File file,
                                   byte[] bytes)
                            throws java.io.IOException

Writes the given bytes to the given file. Directories are created as needed. The file is closed after writing.

Throws:

java.io.IOException

mergeTemplate

public static void mergeTemplate(java.io.File templateFile,
                                 java.io.File outFile,
                                 java.lang.Object... arguments)
                          throws java.io.IOException

Loads template file with a Format string, formats it and writes result to file.

Parameters:

templateFile - the template file with the format string

outFile - the target file, parent directories are created automatically.

arguments - the formatting arguments.

Throws:

java.io.IOException - if an IO exception occurs or the template file defines an illegal format.

mergeTemplate

public static java.io.InputStream mergeTemplate(java.io.InputStream inStream,
                                                java.lang.Object... arguments)
                                         throws java.io.IOException

Loads template file with a Format string, formats it and provides result as stream. No streams are closed by this method.

Parameters:

inStream - stream that provides the template format string

arguments - the formatting arguments.

Throws:

java.io.IOException - if an IOException occurs or the template file defines an illegal format.

readStream

public static java.lang.String readStream(java.io.InputStream input)
                                   throws java.io.IOException

Read input stream into string.

Throws:

java.io.IOException

readStreamUTF8

public static java.lang.String readStreamUTF8(java.io.InputStream input)
                                       throws java.io.IOException

Read input stream into string.

Throws:

java.io.IOException

readStream

public static java.lang.String readStream(java.io.InputStream input,
                                          java.nio.charset.Charset encoding)
                                   throws java.io.IOException

Read input stream into string. This method is BOM aware, i.e. deals with the UTF-BOM.

Throws:

java.io.IOException

readStreamBinary

public static byte[] readStreamBinary(java.io.InputStream input)
                               throws java.io.IOException

Read input stream into raw byte array.

Throws:

java.io.IOException

streamReader

public static java.io.Reader streamReader(java.io.InputStream in,
                                          java.nio.charset.Charset encoding)
                                   throws java.io.IOException

Returns a reader that wraps the given input stream. This method handles the BOM transparently. As the normal reader constructors can not deal with this, direct construction of readers is discouraged.

Throws:

java.io.IOException

readProperties

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

Reads properties from a properties file.

Throws:

java.io.IOException

readProperties

public static java.util.Properties readProperties(Resource resource)
                                           throws java.io.IOException

Reads properties from a properties resource.

Throws:

java.io.IOException

readProperties

public static java.util.Properties readProperties(CollectionUtils.SupplierWithException<? extends java.io.InputStream,java.io.IOException> streamSupplier)
                                           throws java.io.IOException

Reads properties from a properties stream.

Throws:

java.io.IOException

commonRoot

public static java.io.File commonRoot(java.lang.Iterable<? extends java.io.File> files)
                               throws java.io.IOException

Determines the root directory from a collection of files. The root directory is the lowest common ancestor directory of the files in the directory tree.

This method does not require the input files to exist.

Parameters:

files - Collection of files for which root directory gets determined. This collection is required to contain at least 2 files. If it does not, an AssertionError is thrown.

Returns:

Root directory, or null, if the files do not have a common root directory.

Throws:

java.lang.AssertionError - If less than two different files are provided whereas fully qualified canonical names are used for comparison.

java.io.IOException - Since canonical paths are used for determination of the common root, and File.getCanonicalPath() can throw IOExceptions.

autoDecompressStream

public static java.io.InputStream autoDecompressStream(java.io.InputStream in)
                                                throws java.io.IOException

Transparently creates a stream for decompression if the provided stream is compressed. Otherwise the stream is just handed through. Currently the following compression methods are supported:

• GZIP via GZIPInputStream

Throws:

java.io.IOException

close

public static void close(ZipFile zipFile)

Closes the given ZIP file quietly, i.e. ignoring a potential IOException. Additionally it is null safe.

close

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

Convenience method for calling close(Closeable, ILogger) with a null-logger.

close

public static void close(java.io.Closeable closeable,
                         ILogger logger)

This method can be used to simplify the typical finally -block of code dealing with streams and readers/writers. It checks if the provided closeable is null. If not it closes it. An exception thrown during the close operation is logged with the provided logger with level warn. If the provided logger is null, no logging is performed. If no logging is required, method close(Closeable) may also be used.

sort

public static void sort(java.util.List<java.io.File> files)

Compares files based on the lexical order of their fully qualified names. Files must not null.

normalizeSeparators

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

Replace platform dependent separator char with forward slashes to create system-independent paths.

extractJarFileFromJarURL

public static java.io.File extractJarFileFromJarURL(java.net.URL url)

Returns the JAR file for an URL with protocol 'jar'. If the protocol is not 'jar' an assertion error will be caused! An assertion error is also thrown if URL does not point to a file.

isAbsolutePath

public static boolean isAbsolutePath(java.lang.String filename)

Returns whether a filename represents an absolute path. This method returns the same result, independent on which operating system it gets executed. In contrast, the behavior of File.isAbsolute() is operating system specific.

safeRead

public static void safeRead(java.io.InputStream in,
                            byte[] data)
                     throws java.io.IOException,
                            java.io.EOFException

Reads bytes of data from the input stream into an array of bytes until the array is full. This method blocks until input data is available, end of file is detected, or an exception is thrown. The reason for this method is that InputStream.read(byte[]) may read less than the requested number of bytes, while this method ensures the data is complete.

Parameters:

in - the stream to read from.

data - the stream to read from.

Throws:

java.io.IOException - if reading the underlying stream causes an exception.

java.io.EOFException - if the end of file was reached before the requested data was read.

safeRead

public static void safeRead(java.io.InputStream in,
                            byte[] data,
                            int offset,
                            int length)
                     throws java.io.IOException,
                            java.io.EOFException

Reads length bytes of data from the input stream into an array of bytes and stores it at position offset. This method blocks until input data is available, end of file is detected, or an exception is thrown. The reason for this method is that InputStream.read(byte[], int, int) may read less than the requested number of bytes, while this method ensures the data is complete.

Parameters:

in - the stream to read from.

data - the stream to read from.

offset - the offset in the array where the first read byte is stored.

length - the length of data read.

Throws:

java.io.IOException - if reading the underlying stream causes an exception.

java.io.EOFException - if the end of file was reached before the requested data was read.

getTmpDir

public static java.io.File getTmpDir()

Obtains the system's temporary directory

getUserHomeDir

public static java.io.File getUserHomeDir()

Obtains the current user's home directory

getWorkspaceDir

public static java.io.File getWorkspaceDir()

Obtains the current working directory. This is usually the directory in which the current Java process was started.

contentsEqual

public static boolean contentsEqual(java.io.File file1,
                                    java.io.File file2)
                             throws java.io.IOException

Checks whether two files have the same content.

Throws:

java.io.IOException

openJarFileEntry

public static java.io.InputStream openJarFileEntry(java.util.jar.JarFile jarFile,
                                                   java.lang.String entryName)
                                            throws java.io.IOException

Opens an InputStream for the entry with the given name in the given JAR file

Throws:

java.io.IOException

isReadableFile

public static boolean isReadableFile(java.io.File... files)

Returns whether the given file is non-null, a plain file and is readable.

concatenatePaths

public static java.lang.String concatenatePaths(java.lang.String firstParent,
                                                java.lang.String... paths)

Concatenates all path parts into a single path with normalized separators.

recursivelyRemoveDirectoryIfEmpty

public static void recursivelyRemoveDirectoryIfEmpty(java.io.File path)
                                              throws java.io.IOException

Removes the given path if it is an empty directory and recursively parent directories if the only child was deleted. If the given path points to file which does not exist, the parent directory of that file is deleted.

Throws:

java.io.IOException - if an I/O error during deletion occurs.

getNonExistingFile

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

Returns a file that does not exist in the same directory of the given file. It either returns the passed file (if not exiting) or appends a number between the filename and the extension to ensure uniqueness, e.g. path/to/file_1.ext if path/to/file.ext is passed but this file already exists. The number is incremented until the file does not exist.

parseDataSize

public static long parseDataSize(java.lang.String dataSize)

Converts the given human readable data size to the corresponding number of bytes. For example "1 KB" is converted to 1024. Also supports Si units ("1 KiB" is converted to 1000). Commas are ignored and can be used as thousands separator. A dot is the decimal separator. ("1.2KiB" is converted to 1200). Method implementation based on stackoverflow https://stackoverflow.com/a/45860167

getLastModifiedTimestamp

public static long getLastModifiedTimestamp(java.io.File file)
                                     throws java.io.IOException

Determines the last modified timestamp in a platform agnostic way.

Throws:

java.io.IOException

toSafeFilename

public static java.lang.String toSafeFilename(java.lang.String name)

Returns a safe filename that can be used for downloads. Replaces everything that is not a letter or number with "-"

escapeReservedFileNames

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

Returns a new file with all file path segments that are reserved (windows) path names escaped.

readFileSystemIndependent

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

Reads a file using UTF-8 encoding and normalizes line breaks (replacing "\n\r" and "\r" with "\n"). This generates an OS-independent view on a file. To ensure OS-independent test results, this method should be used in all tests to read files.

Throws:

java.io.IOException

replaceFilePathFilenameWith

public static java.lang.String replaceFilePathFilenameWith(java.lang.String uniformPath,
                                                           java.lang.String newFileName)

Replaces the file name of the given path with the given new extension. Returns the newFileName if the file denoted by the uniform path does not contain a '/'. This method assumes that folders are separated by '/' (uniform paths). Examples:

• replaceFilePathFilenameWith("xx", "yy") returns "yy"
• replaceFilePathFilenameWith("xx/zz", "yy") returns * "xx/yy"
• replaceFilePathFilenameWith("xx/zz/", "yy") returns * "xx/zz/yy"
• replaceFilePathFilenameWith("", "yy") returns * "yy"