CommonsFileUtils

Computes the checksum of a file using the specified checksum object. Multiple files may be checked using one Checksum instance if desired simply by reusing the same checksum object. For example:

  long csum = FileUtils.checksum(file, new CRC32()).getValue();

Computes the checksum of a file using the CRC32 checksum routine. The value of the checksum is returned.

Cleans a directory without deleting it.

Compares 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

Copies a filtered directory to a new location.

This method copies the contents of the specified source directory to within the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: Setting preserveFileDate to true tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Copies a filtered directory to a new location.

This method copies the contents of the specified source directory to within the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: Setting preserveFileDate to true tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Copies a filtered directory to a new location.

This method copies the contents of the specified source directory to within the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: Setting preserveFileDate to true tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Example: Copy directories only

 // only copy the directory structure
 copyDir(destDir, (file: File => file.isDirectory), false);

Copies a filtered directory to a new location.

This method copies the contents of the specified source directory to within the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: Setting preserveFileDate to true tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Example: Copy directories only

 // only copy the directory structure
 copyDir(destDir, (file: File => file.isDirectory), false);

Copies a whole directory to a new location.

This method copies the contents of the specified source directory to within the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: Setting preserveFileDate to true tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Copies a whole directory to a new location.

This method copies the contents of the specified source directory to within the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: Setting preserveFileDate to true tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Copies a whole directory to a new location.

This method copies the contents of the specified source directory to within the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: Setting preserveFileDate to true tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Copies a whole directory to a new location.

This method copies the contents of the specified source directory to within the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: Setting preserveFileDate to true tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Copies a directory to within another directory preserving the file dates.

This method copies the source directory and all its contents to a directory of the same name in the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: This method tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Copies a directory to within another directory preserving the file dates.

This method copies the source directory and all its contents to a directory of the same name in the specified destination directory.

The destination directory is created if it does not exist. If the destination directory did exist, then this method merges the source with the destination, with the source taking precedence.

Note: This method tries to preserve the files' last modified date/times using File#setLastModified(long), however it is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.

Copies a file to a new location.

This method copies the contents of the specified source file to the specified destination file. The directory holding the destination file is created if it does not exist. If the destination file exists, then this method will overwrite it.

Copies a file to a new location.

This method copies the contents of the specified source file to the specified destination file. The directory holding the destination file is created if it does not exist. If the destination file exists, then this method will overwrite it.

Note: Setting preserveFileDate to true tries to preserve the file's last modified date/times using File#setLastModified(long), however it is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.

Copies a file to a new location.

This method copies the contents of the specified source file to the specified destination file. The directory holding the destination file is created if it does not exist. If the destination file exists, then this method will overwrite it.

Copies a file to a new location.

This method copies the contents of the specified source file to the specified destination file. The directory holding the destination file is created if it does not exist. If the destination file exists, then this method will overwrite it.

Note: Setting preserveFileDate to true tries to preserve the file's last modified date/times using File#setLastModified(long), however it is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.

Copies a file to a directory optionally preserving the file date.

This method copies the contents of the specified source file to a file of the same name in the specified destination directory. The destination directory is created if it does not exist. If the destination file exists, then this method will overwrite it.

Note: Setting preserveFileDate to true tries to preserve the file's last modified date/times using File#setLastModified(long), however it is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.

Copies a file to a directory optionally preserving the file date.

This method copies the contents of the specified source file to a file of the same name in the specified destination directory. The destination directory is created if it does not exist. If the destination file exists, then this method will overwrite it.

Note: Setting preserveFileDate to true tries to preserve the file's last modified date/times using File#setLastModified(long), however it is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.

Copies a file to a directory optionally preserving the file date.

This method copies the contents of the specified source file to a file of the same name in the specified destination directory. The destination directory is created if it does not exist. If the destination file exists, then this method will overwrite it.

Note: Setting preserveFileDate to true tries to preserve the file's last modified date/times using File#setLastModified(long), however it is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.

Copies a file to a directory optionally preserving the file date.

This method copies the contents of the specified source file to a file of the same name in the specified destination directory. The destination directory is created if it does not exist. If the destination file exists, then this method will overwrite it.

Note: Setting preserveFileDate to true tries to preserve the file's last modified date/times using File#setLastModified(long), however it is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.

Copies bytes from an InputStream source to a file destination. The directories up to destination will be created if they don't already exist. destination will be overwritten if it already exists.

Copies bytes from the URL source to a file destination. The directories up to destination will be created if they don't already exist. destination will be overwritten if it already exists.

Copies bytes from the URL source to a file destination. The directories up to destination will be created if they don't already exist. destination will be overwritten if it already exists.

Copies bytes from the URL source to a file destination. The directories up to destination will be created if they don't already exist. destination will be overwritten if it already exists.

Warning: this method does not set a connection or read timeout and thus might block forever. Use #copyURLToFile(URL, File, int, int) with reasonable timeouts to prevent this.

Copies bytes from the URL source to a file destination. The directories up to destination will be created if they don't already exist. destination will be overwritten if it already exists.

Warning: this method does not set a connection or read timeout and thus might block forever. Use #copyURLToFile(URL, File, int, int) with reasonable timeouts to prevent this.

Deletes a file, never throwing an exception. If file is a directory, delete it and all sub-directories.

The difference between File.delete() and this method are:

• A directory to be deleted does not have to be empty.
• No exceptions are thrown when a file or directory cannot be deleted.

Returns a human-readable version of the file size, where the input represents a specific number of bytes.

If the size is over 1GB, the size is returned as the number of whole GB, i.e. the size is rounded down to the nearest GB boundary.

Similarly for the 1MB and 1KB boundaries.

Deletes a file. If file is a directory, delete it and all sub-directories.

The difference between File.delete() and this method are:

• A directory to be deleted does not have to be empty.
• You get exceptions when a file or directory cannot be deleted. (java.io.File methods returns a boolean)

Schedules a file to be deleted when JVM exits. If file is directory delete it and all sub-directories.

Makes a directory, including any necessary but nonexistent parent directories. If a file already exists with specified name but it is not a directory then an IOException is thrown. If the directory cannot be created (or does not already exist) then an IOException is thrown.

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

Tests if the specified File is newer than the specified Date.

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

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

Tests if the specified File is older than the specified Date.

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

Determines whether the specified file is a Symbolic Link rather than an actual file.

Will not return true if there is a Symbolic Link anywhere in the path, only if the specific file is.

Returns an Iterator for the lines in a File.

This method opens an InputStream for the file. When you have finished with the iterator you should close the stream to free internal resources. This can be done by calling the LineIterator#close() or LineIterator#closeQuietly(LineIterator) method.

The recommended usage pattern is:

LineIterator it = file.lineIterator("UTF-8");
try {
  while (it.hasNext()) {
    String line = it.nextLine();
    /// do something with line
  }
} finally {
  LineIterator.closeQuietly(iterator);
}

If an exception occurs during the creation of the iterator, the underlying stream is closed.

Finds files within a given directory which match an array of extensions.

Finds files within a given directory and its subdirectories which match an array of extensions.

Moves a directory to another directory. create the destination directory

Moves a directory to another directory. create the destination directory

Moves a directory.

When the destination directory is on another file system, do a "copy and delete".

Moves a directory.

When the destination directory is on another file system, do a "copy and delete".

Moves a directory to another directory.

Moves a directory to another directory.

Moves a file.

When the destination file is on another file system, do a "copy and delete".

Moves a file.

When the destination file is on another file system, do a "copy and delete".

Moves a file to a directory. create the destination directory.

Moves a file to a directory. create the destination directory.

Moves a file to a directory.

Moves a file to a directory.

Moves a file or directory to the destination directory. create the destination directory,

When the destination is on another file system, do a "copy and delete".

Moves a file or directory to the destination directory. create the destination directory,

When the destination is on another file system, do a "copy and delete".

Moves a file or directory to the destination directory.

When the destination is on another file system, do a "copy and delete".

Moves a file or directory to the destination directory.

When the destination is on another file system, do a "copy and delete".

Opens a FileInputStream for the specified file, providing better error messages than simply calling new FileInputStream(file).

At the end of the method either the stream will be successfully opened, or an exception will have been thrown.

An exception is thrown if the file does not exist. An exception is thrown if the file object exists but is a directory. An exception is thrown if the file exists but cannot be read.

Opens a FileOutputStream for the specified file, checking and creating the parent directory if it does not exist.

At the end of the method either the stream will be successfully opened, or an exception will have been thrown.

The parent directory will be created if it does not exist. The file will be created if it does not exist. An exception is thrown if the file object exists but is a directory. An exception is thrown if the file exists but cannot be written to. An exception is thrown if the parent directory cannot be created.

Opens a FileInputStream for the specified file, providing better error messages than simply calling new FileInputStream(file).

At the end of the method either the stream will be successfully opened, or an exception will have been thrown.

An exception is thrown if the file does not exist. An exception is thrown if the file object exists but is a directory. An exception is thrown if the file exists but cannot be read.

Opens a FileOutputStream for the specified file, checking and creating the parent directory if it does not exist.

At the end of the method either the stream will be successfully opened, or an exception will have been thrown.

The parent directory will be created if it does not exist. The file will be created if it does not exist. An exception is thrown if the file object exists but is a directory. An exception is thrown if the file exists but cannot be written to. An exception is thrown if the parent directory cannot be created.

Reads the contents of a file line by line to a List of Strings. The file is always closed.

Reads the contents of a file into a byte array. The file is always closed.

Reads the contents of a file into a String. The file is always closed.

Returns the size of the specified file or directory. If the provided File is a regular file, then the file's length is returned. If the argument is a directory, then the size of the directory is calculated recursively. If a directory or subdirectory is security restricted, its size will not be included.

Counts the size of a directory recursively (sum of the length of all files).

Implements the same behaviour as the "touch" utility on Unix. 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.

NOTE: As from v1.3, this method throws an IOException if the last modified date of the file cannot be set. Also, as from v1.3 this method creates parent directories if they do not exist.

Waits for NFS to propagate a file creation, imposing a timeout.

This method repeatedly tests File#exists() until it returns true up to the maximum time specified in seconds.

Writes a byte array to a file creating the file if it does not exist.

NOTE: the parent directories of the file will be created if they do not exist.

Writes a CharSequence to a file creating the file if it does not exist using the default encoding for the VM.

Writes the toString() value of each item in a collection to the specified File line by line. The specified character encoding and the line ending will be used.

NOTE: the parent directories of the file will be created if they do not exist.