Class FileUtil

java.lang.Object

jodd.io.FileUtil

public class FileUtil
extends Object

File utilities.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	FILE_PROTOCOL
private static final String	MSG_CANT_CREATE
private static final String	MSG_NOT_A_DIRECTORY
private static final String	MSG_NOT_A_FILE
private static final String	MSG_NOT_FOUND
private static final String	MSG_UNABLE_TO_DELETE
private static final int	NEGATIVE_ONE
static String	tempFilePrefix	Default prefix for temporary files.
private static final String	USER_HOME
private static final int	ZERO

Constructor Summary

Constructors

Constructor	Description
FileUtil()

Method Summary

Modifier and Type	Method	Description
private static void	_copyDirectory(File srcDir, File destDir)
private static void	_copyFile(File srcFile, File destFile)	Internal file copy when most of the pre-checking has passed.
private static void	_moveDirectory(File srcDest, File destDir)	Moves a directory.
private static void	_moveFile(File srcFile, File destFile)	Moves a File.
static void	appendBytes(File dest, byte[] data)
static void	appendBytes(File dest, byte[] data, int off, int len)	Appends bytes.
static void	appendBytes(String dest, byte[] data)
static void	appendBytes(String dest, byte[] data, int off, int len)
static void	appendString(File dest, String data)
static void	appendString(File dest, String data, Charset encoding)	Appends String.
static void	appendString(String dest, String data)
static void	appendString(String dest, String data, Charset encoding)
private static File	checkCreateDirectory(File dir)	Checks if directory can be created.
private static void	checkDeleteSuccessful(File dir)	Checks if directory can be deleted.
private static void	checkDirCopy(File srcDir, File destDir)	Checks that srcDir exists, that it is a directory and if srcDir and destDir are not equal.
private static void	checkExists(File file)	Checks if File exists.
private static void	checkExistsAndDirectory(File dir)	Checks if directory exists.
private static void	checkFileCopy(File srcFile, File destFile)	Checks that file copy can occur.
private static void	checkIsDirectory(File dir)	Checks if File is a directory.
private static void	checkIsFile(File file)	Checks if File is a file.
private static void	checkReferenceExists(File file)	Checks if File exists.
static void	cleanDir(File destDir)	Cleans a directory without deleting it.
static void	cleanDir(String dest)
static boolean	compare(File one, File two)	Compare the contents of two Files to determine if they are equal or not.
static boolean	compare(String file1, String file2)
static void	copy(File src, File dest)	Smart copy.
static void	copy(String src, String dest)
static void	copyDir(File srcDir, File destDir)	Copies directory with specified copy params.
static void	copyDir(String srcDir, String destDir)
static void	copyFile(File srcFile, File destFile)	Copies a File to another File.
static void	copyFile(String srcFile, String destFile)
static File	copyFileToDir(File srcFile, File destDir)	Copies a File to directory with specified copy params and returns copied destination.
static File	copyFileToDir(String srcFile, String destDir)
static File	createTempDirectory()
static File	createTempDirectory(String prefix, String suffix)
static File	createTempDirectory(String prefix, String suffix, File tempDir)	Creates temporary directory.
static File	createTempFile()
static File	createTempFile(String prefix, String suffix, File tempDir)	Creates temporary File.
static File	createTempFile(String prefix, String suffix, File tempDir, boolean create)	Creates temporary File.
static void	delete(File dest)	Smart delete of destination file or directory.
static void	delete(String dest)
static void	deleteDir(File destDir)	Deletes a directory.
static void	deleteDir(String destDir)
static void	deleteFile(File destFile)	Deletes a File.
static void	deleteFile(String destFile)
private static Charset	detectEncoding(UnicodeInputStream in)	Detect encoding on UnicodeInputStream by using UnicodeInputStream.getDetectedEncoding().
private static Charset	encoding()	Returns default encoding.
static boolean	equals(File one, File two)	Checks if two Files point to the same File.
static boolean	equals(String one, String two)
private static File	file(File parent, String fileName)	Simple factory for File objects.
static File	file(String fileName)	Simple factory for File objects but with home resolving.
static File	getParentFile(File file)	Returns parent for the file.
static boolean	isAncestor(File ancestor, File file, boolean strict)	Check if one File is an ancestor of second one.
static boolean	isBinary(File file)	Checks the start of the file for ASCII control characters
static boolean	isExistingFile(File file)	Returns true if File exists.
static boolean	isExistingFolder(File folder)	Returns true if directory exists.
static boolean	isFilePathAcceptable(File file, FileFilter fileFilter)	Checks if file and its ancestors are acceptable by using FileFilter.accept(File).
static boolean	isNewer(File file, long timeMillis)	Tests if the specified File is newer than the specified time reference.
static boolean	isNewer(File file, File reference)	Uses File.lastModified() for reference.
static boolean	isNewer(String file, long timeMillis)
static boolean	isNewer(String file, String reference)
static boolean	isOlder(File file, long timeMillis)	Tests if the specified File is older than the specified time reference.
static boolean	isOlder(File file, File reference)	Uses File.lastModified() for reference.
static boolean	isOlder(String file, long timeMillis)
static boolean	isOlder(String file, String reference)
static boolean	isSymlink(File file)	Deprecated. Files.isSymbolicLink(java.nio.file.Path) provides this functionality natively as of Java 1.7.
static String	md5(File file)	Creates MD5 digest of a File.
static File	mkdir(File dir)	Creates single directory.
static File	mkdir(String dir)
static File	mkdirs(File dirs)	Creates all directories at once.
static File	mkdirs(String dirs)
static void	move(File src, File dest)	Smart move.
static void	move(String src, String dest)
static File	moveDir(File srcDir, File destDir)
static File	moveDir(String srcDir, String destDir)
static File	moveFile(File srcFile, File destFile)
static File	moveFile(String srcFile, String destFile)
static File	moveFileToDir(File srcFile, File destDir)	Moves a file to a directory.
static File	moveFileToDir(String srcFile, String destDir)
protected static void	outBytes(File dest, byte[] data, int off, int len, boolean append)	Writes data to File destination.
protected static void	outChars(File dest, char[] data, Charset encoding, boolean append)	Writes characters to File destination.
protected static void	outString(File dest, String data, Charset encoding, boolean append)	Writes data using encoding to File.
static byte[]	readBytes(File file)
static byte[]	readBytes(File file, int count)	Read file and returns byte array with contents.
static byte[]	readBytes(String file)
static char[]	readChars(File file)
static char[]	readChars(File file, Charset encoding)	Reads file content as char array.
static char[]	readChars(String fileName)
static char[]	readChars(String fileName, Charset encoding)
static String[]	readLines(File source)
static String[]	readLines(File file, Charset encoding)	Reads lines from source File with specified encoding and returns lines as Strings in array.
static String[]	readLines(String source)
static String[]	readLines(String source, Charset encoding)
static String	readString(File source)
static String	readString(File file, Charset encoding)	Reads File content as String encoded in provided encoding.
static String	readString(String source)
static String	readString(String source, Charset encoding)
static char[]	readUTFChars(File file)	Reads UTF file content as char array.
static char[]	readUTFChars(String fileName)
static String	readUTFString(File file)	Detects optional BOM and reads UTF String from a File.
static String	readUTFString(InputStream inputStream)	Detects optional BOM and reads UTF String from an InputStream.
static String	readUTFString(String fileName)
static String	sha256(File file)	Creates SHA-256 digest of a file.
static String	sha512(File file)	Creates SHA-512 digest of a file.
private static InputStream	streamOf(File file, Charset encoding)	Returns either new FileInputStream or new UnicodeInputStream.
static File	toContainerFile(URL url)	Returns a file of either a folder or a containing archive.
static File	toFile(URL url)	Converts File URLs to File.
static String	toFileName(URL url)	Converts File URLs to file name.
static void	touch(File file)	Implements the Unix "touch" utility.
static void	touch(String file)
static URL	toURL(File file)	Converts File to URL in a correct way.
private static UnicodeInputStream	unicodeInputStreamOf(File file)
private static UnicodeInputStream	unicodeInputStreamOf(InputStream input, Charset targetEncoding)	Returns new UnicodeInputStream using InputStream and targetEncoding.
static void	writeBytes(File dest, byte[] data)
static void	writeBytes(File dest, byte[] data, int off, int len)	Write bytes.
static void	writeBytes(String dest, byte[] data)
static void	writeBytes(String dest, byte[] data, int off, int len)
static void	writeChars(File dest, char[] data)
static void	writeChars(File dest, char[] data, Charset encoding)	Write characters.
static void	writeChars(String dest, char[] data)
static void	writeChars(String dest, char[] data, Charset encoding)
static void	writeStream(FileOutputStream out, InputStream in)	Write InputStream in to FileOutputStream.
static void	writeStream(File dest, InputStream in)
static void	writeStream(String dest, InputStream in)
static void	writeString(File dest, String data)
static void	writeString(File dest, String data, Charset encoding)	Writes String.
static void	writeString(String dest, String data)
static void	writeString(String dest, String data, Charset encoding)

Methods inherited from class Object

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

Field Details

tempFilePrefix

public static String tempFilePrefix

Default prefix for temporary files.

MSG_NOT_A_DIRECTORY

private static final String MSG_NOT_A_DIRECTORY

See Also:

• Constant Field Values

MSG_CANT_CREATE

private static final String MSG_CANT_CREATE

See Also:

• Constant Field Values

MSG_NOT_FOUND

private static final String MSG_NOT_FOUND

See Also:

• Constant Field Values

MSG_NOT_A_FILE

private static final String MSG_NOT_A_FILE

See Also:

• Constant Field Values

MSG_UNABLE_TO_DELETE

private static final String MSG_UNABLE_TO_DELETE

See Also:

• Constant Field Values

ZERO

private static final int ZERO

See Also:

• Constant Field Values

NEGATIVE_ONE

private static final int NEGATIVE_ONE

See Also:

• Constant Field Values

FILE_PROTOCOL

private static final String FILE_PROTOCOL

See Also:

• Constant Field Values

USER_HOME

private static final String USER_HOME

See Also:

• Constant Field Values

Constructor Details

FileUtil

public FileUtil()

Method Details

file

public static File file(String fileName)

Simple factory for File objects but with home resolving.

file

private static File file(File parent,
 String fileName)

Simple factory for File objects.

equals

public static boolean equals(String one,
 String two)

See Also:

• equals(File, File)

equals

public static boolean equals(File one,
 File two)

Checks if two Files point to the same File.

Parameters:

one - File one.

two - File two.

Returns:

true if the Files match.

toFile

public static File toFile(URL url)

Converts File URLs to File. Ignores other schemes and returns null.

toURL

public static URL toURL(File file)
                 throws MalformedURLException

Converts File to URL in a correct way.

Returns:

URL or null in case of error.

Throws:

MalformedURLException - if File cannot be converted.

toFileName

public static String toFileName(URL url)

Converts File URLs to file name. Accepts only URLs with 'file' protocol. Otherwise, for other schemes returns null.

Parameters:

url - URL to convert

Returns:

file name

toContainerFile

public static File toContainerFile(URL url)

Returns a file of either a folder or a containing archive.

isExistingFile

public static boolean isExistingFile(File file)

Returns true if File exists.

isExistingFolder

public static boolean isExistingFolder(File folder)

Returns true if directory exists.

mkdirs

public static File mkdirs(String dirs)
                   throws IOException

Throws:

IOException

See Also:

• mkdirs(File)

mkdirs

public static File mkdirs(File dirs)
                   throws IOException

Creates all directories at once.

Parameters:

dirs - Directories to make.

Throws:

IOException - if cannot create directory.

mkdir

public static File mkdir(String dir)
                  throws IOException

Throws:

IOException

See Also:

• mkdir(File)

mkdir

public static File mkdir(File dir)
                  throws IOException

Creates single directory.

Throws:

IOException - if cannot create directory.

touch

public static void touch(String file)
                  throws IOException

Throws:

IOException

See Also:

• touch(File)

touch

public static void touch(File file)
                  throws IOException

Implements the Unix "touch" utility. It creates a new File with size 0 or, if the File exists already, it is opened and closed without modifying it, but updating the File date and time.

Throws:

IOException

copyFile

public static void copyFile(String srcFile,
 String destFile)
                     throws IOException

Throws:

IOException

See Also:

• copyFile(File, File)

copyFile

public static void copyFile(File srcFile,
 File destFile)
                     throws IOException

Copies a File to another File.

Parameters:

srcFile - Source File.

destFile - Destination File.

Throws:

IOException - if cannot copy

_copyFile

private static void _copyFile(File srcFile,
 File destFile)
                       throws IOException

Internal file copy when most of the pre-checking has passed.

Parameters:

srcFile - Source File.

destFile - Destination File.

Throws:

IOException - if cannot copy

copyFileToDir

public static File copyFileToDir(String srcFile,
 String destDir)
                          throws IOException

Throws:

IOException

See Also:

• copyFileToDir(File, File)

copyFileToDir

public static File copyFileToDir(File srcFile,
 File destDir)
                          throws IOException

Copies a File to directory with specified copy params and returns copied destination.

Throws:

IOException

copyDir

public static void copyDir(String srcDir,
 String destDir)
                    throws IOException

Throws:

IOException

See Also:

• copyDir(File, File)

copyDir

public static void copyDir(File srcDir,
 File destDir)
                    throws IOException

Copies directory with specified copy params.

Throws:

IOException

See Also:

• _copyDirectory(File, File)

_copyDirectory

private static void _copyDirectory(File srcDir,
 File destDir)
                            throws IOException

Parameters:

srcDir -

destDir -

Throws:

IOException

moveFile

public static File moveFile(String srcFile,
 String destFile)
                     throws IOException

Throws:

IOException

See Also:

• moveFile(File, File)

moveFile

public static File moveFile(File srcFile,
 File destFile)
                     throws IOException

Throws:

IOException

See Also:

• _moveFile(File, File)

_moveFile

private static void _moveFile(File srcFile,
 File destFile)
                       throws IOException

Moves a File.

Parameters:

srcFile - Source File.

destFile - Destination directory.

Throws:

IOException

moveFileToDir

public static File moveFileToDir(String srcFile,
 String destDir)
                          throws IOException

Throws:

IOException

See Also:

• moveFileToDir(File, File)

moveFileToDir

public static File moveFileToDir(File srcFile,
 File destDir)
                          throws IOException

Moves a file to a directory.

Parameters:

srcFile - Source File.

destDir - Destination directory.

Throws:

IOException - if there is an error during move.

moveDir

public static File moveDir(String srcDir,
 String destDir)
                    throws IOException

Throws:

IOException

See Also:

• moveDir(File, File)

moveDir

public static File moveDir(File srcDir,
 File destDir)
                    throws IOException

Throws:

IOException

See Also:

• _moveDirectory(File, File)

_moveDirectory

private static void _moveDirectory(File srcDest,
 File destDir)
                            throws IOException

Moves a directory.

Parameters:

srcDest - Source directory

destDir - Destination directory.

Throws:

IOException - if there is an error during move.

deleteFile

public static void deleteFile(String destFile)
                       throws IOException

Throws:

IOException

See Also:

• deleteFile(File)

deleteFile

public static void deleteFile(File destFile)
                       throws IOException

Deletes a File.

Parameters:

destFile - Destination to delete.

Throws:

IOException - if there was an error deleting.

deleteDir

public static void deleteDir(String destDir)
                      throws IOException

Throws:

IOException

See Also:

• deleteDir(File)

deleteDir

public static void deleteDir(File destDir)
                      throws IOException

Deletes a directory.

Parameters:

destDir - Destination to delete.

Throws:

IOException - if there was an error deleting.

cleanDir

public static void cleanDir(String dest)
                     throws IOException

Throws:

IOException

See Also:

• cleanDir(File)

cleanDir

public static void cleanDir(File destDir)
                     throws IOException

Cleans a directory without deleting it.

Parameters:

destDir - destination to clean.

Throws:

IOException - if something went wrong.

readUTFChars

public static char[] readUTFChars(String fileName)
                           throws IOException

Throws:

IOException

See Also:

• readUTFChars(File)

readUTFChars

public static char[] readUTFChars(File file)
                           throws IOException

Reads UTF file content as char array.

Parameters:

file - File to read.

Returns:

array of characters.

Throws:

IOException - if something went wrong.

readChars

public static char[] readChars(File file,
 Charset encoding)
                        throws IOException

Reads file content as char array.

Parameters:

file - File to read.

encoding - Encoding to use.

Returns:

array of characters.

Throws:

IOException - if something went wrong.

readChars

public static char[] readChars(String fileName)
                        throws IOException

Throws:

IOException

See Also:

• readChars(String, Charset)

readChars

public static char[] readChars(File file)
                        throws IOException

Throws:

IOException

See Also:

• readChars(File, Charset)

readChars

public static char[] readChars(String fileName,
 Charset encoding)
                        throws IOException

Throws:

IOException

See Also:

• readChars(File, Charset)

writeChars

public static void writeChars(File dest,
 char[] data)
                       throws IOException

Throws:

IOException

See Also:

• writeChars(File, char[], Charset)

writeChars

public static void writeChars(String dest,
 char[] data)
                       throws IOException

Throws:

IOException

See Also:

• writeChars(File, char[])

writeChars

public static void writeChars(String dest,
 char[] data,
 Charset encoding)
                       throws IOException

Throws:

IOException

See Also:

• writeChars(File, char[], Charset)

writeChars

public static void writeChars(File dest,
 char[] data,
 Charset encoding)
                       throws IOException

Write characters. append = false

Throws:

IOException

See Also:

• outChars(File, char[], Charset, boolean)

outChars

protected static void outChars(File dest,
 char[] data,
 Charset encoding,
 boolean append)
                        throws IOException

Writes characters to File destination.

Parameters:

dest - destination File

data - Data as a String

encoding - Encoding as a String

append - true if appending; false if File should be overwritten.

Throws:

IOException - if something went wrong.

readUTFString

public static String readUTFString(String fileName)
                            throws IOException

Throws:

IOException

See Also:

• readUTFString(File)

readUTFString

public static String readUTFString(File file)
                            throws IOException

Detects optional BOM and reads UTF String from a File. If BOM is missing, UTF-8 is assumed.

Parameters:

file - File to read.

Returns:

String in UTF encoding.

Throws:

IOException - if copy to InputStream errors.

See Also:

• unicodeInputStreamOf(File)
• IOUtil.copy(InputStream, Charset)

readUTFString

public static String readUTFString(InputStream inputStream)
                            throws IOException

Detects optional BOM and reads UTF String from an InputStream. If BOM is missing, UTF-8 is assumed.

Parameters:

inputStream - InputStream to read.

Returns:

String in UTF encoding.

Throws:

IOException - if copy to InputStream errors.

See Also:

• unicodeInputStreamOf(File)
• IOUtil.copy(InputStream, Charset)

readString

public static String readString(File file,
 Charset encoding)
                         throws IOException

Reads File content as String encoded in provided encoding. For UTF encoded files, detects optional BOM characters.

Parameters:

file - File to read.

encoding - Encoding to use.

Returns:

String representing File content.

Throws:

IOException - if copy to InputStream errors.

See Also:

• streamOf(File, Charset)
• IOUtil.copy(InputStream, Charset)

readString

public static String readString(String source)
                         throws IOException

Throws:

IOException

See Also:

• readString(String, Charset)

readString

public static String readString(String source,
 Charset encoding)
                         throws IOException

Throws:

IOException

See Also:

• readString(File, Charset)

readString

public static String readString(File source)
                         throws IOException

Throws:

IOException

See Also:

• readString(File, Charset)

writeString

public static void writeString(String dest,
 String data)
                        throws IOException

Throws:

IOException

See Also:

• writeString(File, String, Charset)

writeString

public static void writeString(String dest,
 String data,
 Charset encoding)
                        throws IOException

Throws:

IOException

See Also:

• writeString(File, String, Charset)

writeString

public static void writeString(File dest,
 String data)
                        throws IOException

Throws:

IOException

See Also:

• writeString(File, String, Charset)

writeString

public static void writeString(File dest,
 String data,
 Charset encoding)
                        throws IOException

Writes String. append = false

Throws:

IOException

See Also:

• outString(File, String, Charset, boolean)

appendString

public static void appendString(String dest,
 String data)
                         throws IOException

Throws:

IOException

See Also:

• appendString(File, String)

appendString

public static void appendString(String dest,
 String data,
 Charset encoding)
                         throws IOException

Throws:

IOException

See Also:

• appendString(File, String, Charset)

appendString

public static void appendString(File dest,
 String data)
                         throws IOException

Throws:

IOException

See Also:

• appendString(File, String, Charset)

appendString

public static void appendString(File dest,
 String data,
 Charset encoding)
                         throws IOException

Appends String. append = true

Throws:

IOException

See Also:

• outString(File, String, Charset, boolean)

outString

protected static void outString(File dest,
 String data,
 Charset encoding,
 boolean append)
                         throws IOException

Writes data using encoding to File.

Parameters:

dest - destination File

data - Data as a String

encoding - Encoding as a String

append - true if appending; false if File should be overwritten.

Throws:

IOException - if something went wrong.

writeStream

public static void writeStream(String dest,
 InputStream in)
                        throws IOException

Throws:

IOException

See Also:

• writeStream(File, InputStream)

writeStream

public static void writeStream(File dest,
 InputStream in)
                        throws IOException

Throws:

IOException

See Also:

• writeStream(FileOutputStream, InputStream)

writeStream

public static void writeStream(FileOutputStream out,
 InputStream in)
                        throws IOException

Write InputStream in to FileOutputStream.

Parameters:

out - FileOutputStream to write to.

in - InputStream to read.

Throws:

IOException - if there is an issue reading/writing.

readLines

public static String[] readLines(String source)
                          throws IOException

Throws:

IOException

See Also:

• readLines(String, Charset)

readLines

public static String[] readLines(String source,
 Charset encoding)
                          throws IOException

Throws:

IOException

See Also:

• readLines(File, Charset)

readLines

public static String[] readLines(File source)
                          throws IOException

Throws:

IOException

See Also:

• readLines(File, Charset)

readLines

public static String[] readLines(File file,
 Charset encoding)
                          throws IOException

Reads lines from source File with specified encoding and returns lines as Strings in array.

Parameters:

file - File to read.

encoding - Endoing to use.

Returns:

array of Strings which represents lines in the File.

Throws:

IOException - if File does not exist or is not a File or there is an issue reading the File.

readBytes

public static byte[] readBytes(String file)
                        throws IOException

Throws:

IOException

See Also:

• readBytes(File)

readBytes

public static byte[] readBytes(File file)
                        throws IOException

Throws:

IOException

See Also:

• readBytes(File, int)

readBytes

public static byte[] readBytes(File file,
 int count)
                        throws IOException

Read file and returns byte array with contents.

Parameters:

file - File to read

count - number of bytes to read

Returns:

byte array from File contents.

Throws:

IOException - if not a File or File does not exist or file size is larger than Integer.MAX_VALUE.

writeBytes

public static void writeBytes(String dest,
 byte[] data)
                       throws IOException

Throws:

IOException

See Also:

• writeBytes(File, byte[])

writeBytes

public static void writeBytes(File dest,
 byte[] data)
                       throws IOException

Throws:

IOException

See Also:

• writeBytes(File, byte[], int, int)

writeBytes

public static void writeBytes(String dest,
 byte[] data,
 int off,
 int len)
                       throws IOException

Throws:

IOException

See Also:

• writeBytes(File, byte[], int, int)

writeBytes

public static void writeBytes(File dest,
 byte[] data,
 int off,
 int len)
                       throws IOException

Write bytes. append = false

Throws:

IOException

See Also:

• outBytes(File, byte[], int, int, boolean)

appendBytes

public static void appendBytes(String dest,
 byte[] data)
                        throws IOException

Throws:

IOException

See Also:

• appendBytes(File, byte[])

appendBytes

public static void appendBytes(String dest,
 byte[] data,
 int off,
 int len)
                        throws IOException

Throws:

IOException

See Also:

• appendBytes(File, byte[], int, int)

appendBytes

public static void appendBytes(File dest,
 byte[] data)
                        throws IOException

Throws:

IOException

See Also:

• appendBytes(File, byte[], int, int)

appendBytes

public static void appendBytes(File dest,
 byte[] data,
 int off,
 int len)
                        throws IOException

Appends bytes. append = true

Throws:

IOException

See Also:

• outBytes(File, byte[], int, int, boolean)

outBytes

protected static void outBytes(File dest,
 byte[] data,
 int off,
 int len,
 boolean append)
                        throws IOException

Writes data to File destination.

Parameters:

dest - destination File

data - Data as a String

off - the start offset in the data.

len - the number of bytes to write.

append - true if appending; false if File should be overwritten.

Throws:

IOException - if something went wrong.

compare

public static boolean compare(String file1,
 String file2)
                       throws IOException

Throws:

IOException

compare

public static boolean compare(File one,
 File two)
                       throws IOException

Compare the contents of two Files to determine if they are equal or not.

This method checks to see if the two Files are different lengths or if they point to the same File, before resorting to byte-by-byte comparison of the contents.

Code origin: Avalon

Throws:

IOException

isOlder

public static boolean isOlder(String file,
 String reference)

See Also:

• isOlder(File, File)

isNewer

public static boolean isNewer(String file,
 String reference)

See Also:

• isNewer(File, File)

isNewer

public static boolean isNewer(File file,
 File reference)

Uses File.lastModified() for reference.

See Also:

• isNewer(File, long)

isOlder

public static boolean isOlder(File file,
 File reference)

Uses File.lastModified() for reference.

See Also:

• isOlder(File, long)

isNewer

public static boolean isNewer(File file,
 long timeMillis)

Tests if the specified File is newer than the specified time reference.

Parameters:

file - the File of which the modification date must be compared.

timeMillis - the time reference measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)

Returns:

true if the File exists and has been modified after the given time reference.

isNewer

public static boolean isNewer(String file,
 long timeMillis)

See Also:

• isNewer(File, long)

isOlder

public static boolean isOlder(File file,
 long timeMillis)

Tests if the specified File is older than the specified time reference.

Parameters:

file - the File of which the modification date must be compared.

timeMillis - the time reference measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)

Returns:

true if the File exists and has been modified after the given time reference.

isOlder

public static boolean isOlder(String file,
 long timeMillis)

See Also:

• isOlder(File, long)

copy

public static void copy(String src,
 String dest)
                 throws IOException

Throws:

IOException

See Also:

• copy(File, File)

copy

public static void copy(File src,
 File dest)
                 throws IOException

Smart copy. If source is a directory, copy it to destination. Otherwise, if destination is directory, copy source file to it. Otherwise, try to copy source file to destination file.

Parameters:

src - source File

dest - destination File

Throws:

IOException - if there is an error copying.

See Also:

• copyDir(File, File)
• copyFileToDir(File, File)
• copyFile(File, File)

move

public static void move(String src,
 String dest)
                 throws IOException

Throws:

IOException

See Also:

• move(File, File)

move

public static void move(File src,
 File dest)
                 throws IOException

Smart move. If source is a directory, move it to destination. Otherwise, if destination is directory, move source File to it. Otherwise, try to move source File to destination File.

Parameters:

src - source File

dest - destination File

Throws:

IOException - if there is an error moving.

See Also:

• moveDir(File, File)
• moveFileToDir(File, File)
• moveFile(File, File)

delete

public static void delete(String dest)
                   throws IOException

Throws:

IOException

See Also:

• delete(File)

delete

public static void delete(File dest)
                   throws IOException

Smart delete of destination file or directory.

Throws:

IOException - if there is an issue deleting the file/directory.

See Also:

• deleteFile(File)
• deleteDir(File)

isAncestor

public static boolean isAncestor(File ancestor,
 File file,
 boolean strict)

Check if one File is an ancestor of second one.

Parameters:

strict - if c then this method returns true if ancestor and File are equal

Returns:

true if ancestor is parent of File; otherwise, false

getParentFile

public static File getParentFile(File file)

Returns parent for the file. The method correctly processes "." and ".." in File names. The name remains relative if was relative before. Returns null if the File has no parent.

Parameters:

file - File

Returns:

null if the File has no parent.

isFilePathAcceptable

public static boolean isFilePathAcceptable(File file,
 FileFilter fileFilter)

Checks if file and its ancestors are acceptable by using FileFilter.accept(File).

Parameters:

file - File to check.

fileFilter - FileFilter to use.

Returns:

if file and its ancestors are acceptable

createTempDirectory

public static File createTempDirectory()
                                throws IOException

Throws:

IOException

See Also:

• createTempDirectory(String, String)

createTempDirectory

public static File createTempDirectory(String prefix,
 String suffix)
                                throws IOException

Throws:

IOException

See Also:

• createTempDirectory(String, String, File)

createTempDirectory

public static File createTempDirectory(String prefix,
 String suffix,
 File tempDir)
                                throws IOException

Creates temporary directory.

Throws:

IOException

See Also:

• createTempFile(String, String, File)

createTempFile

public static File createTempFile()
                           throws IOException

Throws:

IOException

See Also:

• createTempFile(String, String, File, boolean)

createTempFile

public static File createTempFile(String prefix,
 String suffix,
 File tempDir,
 boolean create)
                           throws IOException

Creates temporary File.

Parameters:

prefix - The prefix string to be used in generating the file's name; must be at least three characters long

suffix - The suffix string to be used in generating the file's name; may be null, in which case the suffix ".tmp" will be used

tempDir - The directory in which the file is to be created, or null if the default temporary-file directory is to be used

create - If create is set to true File will be physically created on the file system. Otherwise, it will be created and then deleted - trick that will make temp File exist only if they are used.

Returns:

File

Throws:

IOException

createTempFile

public static File createTempFile(String prefix,
 String suffix,
 File tempDir)
                           throws IOException

Creates temporary File. Wraps Java method and repeats creation several times if something fails.

Parameters:

prefix - The prefix string to be used in generating the file's name; must be at least three characters long

suffix - The suffix string to be used in generating the file's name; may be null, in which case the suffix ".tmp" will be used

tempDir - The directory in which the file is to be created, or null if the default temporary-file directory is to be used

Throws:

IOException

isSymlink

@Deprecated
public static boolean isSymlink(File file)

Deprecated.

Files.isSymbolicLink(java.nio.file.Path) provides this functionality natively as of Java 1.7.

Determines whether the specified file is a symbolic link rather than an actual file.

md5

public static String md5(File file)
                  throws IOException

Creates MD5 digest of a File.

Parameters:

file - File to create digest of.

Returns:

MD5 digest of the File.

Throws:

IOException

sha256

public static String sha256(File file)
                     throws IOException

Creates SHA-256 digest of a file.

Parameters:

file - File to create digest of.

Returns:

SHA-256 digest of the File.

Throws:

IOException

sha512

public static String sha512(File file)
                     throws IOException

Creates SHA-512 digest of a file.

Parameters:

file - File to create digest of.

Returns:

SHA-512 digest of the File.

Throws:

IOException

isBinary

public static boolean isBinary(File file)
                        throws IOException

Checks the start of the file for ASCII control characters

Parameters:

file - File

Returns:

true if the the start of the File is ASCII control characters.

Throws:

IOException

unicodeInputStreamOf

private static UnicodeInputStream unicodeInputStreamOf(File file)
                                                throws IOException

Throws:

IOException

See Also:

• unicodeInputStreamOf(InputStream, Charset)
• checkExists(File)
• checkIsFile(File)

unicodeInputStreamOf

private static UnicodeInputStream unicodeInputStreamOf(InputStream input,
 Charset targetEncoding)

Returns new UnicodeInputStream using InputStream and targetEncoding.

Parameters:

input - InputStream

targetEncoding - Encoding to use.

Returns:

new UnicodeInputStream.

streamOf

private static InputStream streamOf(File file,
 Charset encoding)
                             throws IOException

Returns either new FileInputStream or new UnicodeInputStream.

Returns:

either FileInputStream or UnicodeInputStream.

Throws:

IOException - if something went wrong.

See Also:

• unicodeInputStreamOf(InputStream, Charset)

detectEncoding

private static Charset detectEncoding(UnicodeInputStream in)

Detect encoding on UnicodeInputStream by using UnicodeInputStream.getDetectedEncoding().

Parameters:

in - UnicodeInputStream

Returns:

UTF encoding as a String. If encoding could not be detected, defaults to UTF_8

See Also:

• UnicodeInputStream.getDetectedEncoding()

checkExists

private static void checkExists(File file)
                         throws FileNotFoundException

Checks if File exists. Throws IOException if not.

Parameters:

file - File

Throws:

FileNotFoundException - if file does not exist.

checkReferenceExists

private static void checkReferenceExists(File file)
                                  throws IllegalArgumentException

Checks if File exists. Throws IllegalArgumentException if not.

Parameters:

file - File

Throws:

IllegalArgumentException - if file does not exist.

checkIsFile

private static void checkIsFile(File file)
                         throws IOException

Checks if File is a file. Throws IOException if not.

Parameters:

file - File

Throws:

IOException - if File is not a file.

checkIsDirectory

private static void checkIsDirectory(File dir)
                              throws IOException

Checks if File is a directory. Throws IOException if not.

Parameters:

dir - Directory

Throws:

IOException - if File is not a directory.

checkExistsAndDirectory

private static void checkExistsAndDirectory(File dir)
                                     throws IOException

Checks if directory exists. Throws IOException if it does not.

Parameters:

dir - Directory

Throws:

IOException - if directory does not exist.

See Also:

• checkIsDirectory(File)

checkCreateDirectory

private static File checkCreateDirectory(File dir)
                                  throws IOException

Checks if directory can be created. Throws IOException if it cannot.

This actually creates directory (and its ancestors) (as per File.mkdirs() }).

Parameters:

dir - Directory

Throws:

IOException - if directory cannot be created.

checkDeleteSuccessful

private static void checkDeleteSuccessful(File dir)
                                   throws IOException

Checks if directory can be deleted. Throws IOException if it cannot. This actually deletes directory (as per File.delete()).

Parameters:

dir - Directory

Throws:

IOException - if directory cannot be created.

checkDirCopy

private static void checkDirCopy(File srcDir,
 File destDir)
                          throws IOException

Checks that srcDir exists, that it is a directory and if srcDir and destDir are not equal.

Parameters:

srcDir - Source directory

destDir - Destination directory

Throws:

IOException - if any of the above conditions are not true.

checkFileCopy

private static void checkFileCopy(File srcFile,
 File destFile)
                           throws IOException

Checks that file copy can occur.

Parameters:

srcFile - Source File

destFile - Destination File

Throws:

IOException - if srcFile does not exist or is not a file or srcFile and destFile are equal or cannot create ancestor directories.

encoding

private static Charset encoding()

Returns default encoding.