SomeFileUtils (Icaro RCA 0.0.1 API)

java.lang.Object
- net.staniscia.rca.swing.common.SomeFileUtils

```
public final class SomeFileUtils
extends Object
```
Some methods from apache-commons-io's FileUtils. Original javadoc follows.
General file manipulation utilities.
Facilities are provided in the following areas:
- writing to a file
- reading from a file
- make a directory including parent directories
- copying files and directories
- deleting files and directories
- converting to and from a URL
- listing files and directories by filter and extension
- comparing file content
- file last changed date
- calculating a checksum
Origin of code: Excalibur, Alexandria, Commons-Utils
Version:

$Id: SomeFileUtils.java 347619 2012-04-19 14:02:31Z speranza $

Author:

Kevin A. Burton, Scott Sanders, Daniel Rall, Christoph.Reck, Peter Donald, Jeff Turner, Matthew Hawthorne, Jeremias Maerki, Stephen Colebourne, Ian Springer, Chris Eldredge, Jim Harrington, Niall Pemberton, Sandy McArthur

Field Summary

Fields
Modifier and Type	Field and Description
`static File[]`	`EMPTY_FILE_ARRAY` An empty array of type `File`.
`private static long`	`FIFTY_MB` The number of bytes in 50 MB.
`static long`	`ONE_GB` The number of bytes in a gigabyte.
`static long`	`ONE_KB` The number of bytes in a kilobyte.
`static long`	`ONE_MB` The number of bytes in a megabyte.
`private static Charset`	`UTF8` The UTF-8 character set, used to decode octets in URLs.

Constructor Summary

Constructors
Constructor and Description

SomeFileUtils()
Instances should NOT be constructed in standard programming.

Constructors
Constructor and Description
`SomeFileUtils()` Instances should NOT be constructed in standard programming.

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`byteCountToDisplaySize(long size)` Returns a human-readable version of the file size, where the input represents a specific number of bytes.
`static void`	`cleanDirectory(File directory)` Cleans a directory without deleting net.
`private static void`	`cleanDirectoryOnExit(File directory)` Cleans a directory without deleting net.
`static boolean`	`contentEquals(File file1, File file2)` Compares the contents of two files to determine if they are equal or not.
`static File[]`	`convertFileCollectionToFileArray(Collection<File> files)` Converts a Collection containing java.io.File instanced into array representation.
`static void`	`copyDirectory(File srcDir, File destDir)` Copies a whole directory to a new location preserving the file dates.
`static void`	`copyDirectory(File srcDir, File destDir, boolean preserveFileDate)` Copies a whole directory to a new location.
`static void`	`copyDirectory(File srcDir, File destDir, FileFilter filter)` Copies a filtered directory to a new location preserving the file dates.
`static void`	`copyDirectory(File srcDir, File destDir, FileFilter filter, boolean preserveFileDate)` Copies a filtered directory to a new location.
`static void`	`copyDirectoryToDirectory(File srcDir, File destDir)` Copies a directory to within another directory preserving the file dates.
`static void`	`copyFile(File srcFile, File destFile)` Copies a file to a new location preserving the file date.
`static void`	`copyFile(File srcFile, File destFile, boolean preserveFileDate)` Copies a file to a new location.
`static void`	`copyFileToDirectory(File srcFile, File destDir)` Copies a file to a directory preserving the file date.
`static void`	`copyFileToDirectory(File srcFile, File destDir, boolean preserveFileDate)` Copies a file to a directory optionally preserving the file date.
`static void`	`copyInputStreamToFile(InputStream source, File destination)` Copies bytes from an `InputStream` `source` to a file `destination`.
`static void`	`copyURLToFile(URL source, File destination)` Copies bytes from the URL `source` to a file `destination`.
`static void`	`copyURLToFile(URL source, File destination, int connectionTimeout, int readTimeout)` Copies bytes from the URL `source` to a file `destination`.
`(package private) static String`	`decodeUrl(String url)` Decodes the specified URL as per RFC 3986, i.e.
`static void`	`deleteDirectory(File directory)` Deletes a directory recursively.
`private static void`	`deleteDirectoryOnExit(File directory)` Schedules a directory recursively for deletion on JVM exit.
`static boolean`	`deleteQuietly(File file)` Deletes a file, never throwing an exception.
`private static void`	`doCopyDirectory(File srcDir, File destDir, FileFilter filter, boolean preserveFileDate, List<String> exclusionList)` Internal copy directory method.
`private static void`	`doCopyFile(File srcFile, File destFile, boolean preserveFileDate)` Internal copy file method.
`static void`	`forceDelete(File file)` Deletes a file.
`static void`	`forceDeleteOnExit(File file)` Schedules a file to be deleted when JVM exits.
`static void`	`forceMkdir(File directory)` Makes a directory, including any necessary but nonexistent parent directories.
`static File`	`getTempDirectory()` Returns a `File` representing the system temporary directory.
`static String`	`getTempDirectoryPath()`
`static File`	`getUserDirectory()` Returns a `File` representing the user's home directory.
`static String`	`getUserDirectoryPath()` Returns the path to the user's home directory.
`static boolean`	`isFileNewer(File file, Date date)` Tests if the specified `File` is newer than the specified `Date`.
`static boolean`	`isFileNewer(File file, File reference)` Tests if the specified `File` is newer than the reference `File`.
`static boolean`	`isFileNewer(File file, long timeMillis)` Tests if the specified `File` is newer than the specified time reference.
`static boolean`	`isFileOlder(File file, Date date)` Tests if the specified `File` is older than the specified `Date`.
`static boolean`	`isFileOlder(File file, File reference)` Tests if the specified `File` is older than the reference `File`.
`static boolean`	`isFileOlder(File file, long timeMillis)` Tests if the specified `File` is older than the specified time reference.
`static boolean`	`isSymlink(File file)` Determines whether the specified file is a Symbolic Link rather than an actual file.
`static void`	`moveDirectory(File srcDir, File destDir)` Moves a directory.
`static void`	`moveDirectoryToDirectory(File src, File destDir, boolean createDestDir)` Moves a directory to another directory.
`static void`	`moveFile(File srcFile, File destFile)` Moves a file.
`static void`	`moveFileToDirectory(File srcFile, File destDir, boolean createDestDir)` Moves a file to a directory.
`static void`	`moveToDirectory(File src, File destDir, boolean createDestDir)` Moves a file or directory to the destination directory.
`static FileInputStream`	`openInputStream(File file)` Opens a `FileInputStream` for the specified file, providing better error messages than simply calling `new FileInputStream(file)`.
`static FileOutputStream`	`openOutputStream(File file)` Opens a `FileOutputStream` for the specified file, checking and creating the parent directory if net does not exist.
`static byte[]`	`readFileToByteArray(File file)` Reads the contents of a file into a byte array.
`static String`	`readFileToString(File file)` Reads the contents of a file into a String using the default encoding for the VM.
`static String`	`readFileToString(File file, String encoding)` Reads the contents of a file into a String.
`static List<String>`	`readLines(File file)` Reads the contents of a file line by line to a List of Strings using the default encoding for the VM.
`static List<String>`	`readLines(File file, String encoding)` Reads the contents of a file line by line to a List of Strings.
`static long`	`sizeOf(File file)` Returns the size of the specified file or directory.
`static long`	`sizeOfDirectory(File directory)` Counts the size of a directory recursively (sum of the length of all files).
`static File`	`toFile(URL url)` Convert from a `URL` to a `File`.
`static File[]`	`toFiles(URL[] urls)` Converts each of an array of `URL` to a `File`.
`static void`	`touch(File file)` Implements the same behaviour as the "touch" utility on Unix.
`static URL[]`	`toURLs(File[] files)` Converts each of an array of `File` to a `URL`.
`static boolean`	`waitFor(File file, int seconds)` Waits for NFS to propagate a file creation, imposing a timeout.
`static void`	`write(File file, CharSequence data)` Writes a CharSequence to a file creating the file if net does not exist using the default encoding for the VM.
`static void`	`write(File file, CharSequence data, String encoding)` Writes a CharSequence to a file creating the file if net does not exist.
`static void`	`writeByteArrayToFile(File file, byte[] data)` Writes a byte array to a file creating the file if net does not exist.
`static void`	`writeStringToFile(File file, String data)` Writes a String to a file creating the file if net does not exist using the default encoding for the VM.
`static void`	`writeStringToFile(File file, String data, String encoding)` Writes a String to a file creating the file if net does not exist.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ONE_KB
```
public static final long ONE_KB
```
    The number of bytes in a kilobyte.
    
    See Also:
    Constant Field Values
  - ONE_MB
```
public static final long ONE_MB
```
    The number of bytes in a megabyte.
    
    See Also:
    Constant Field Values
  - FIFTY_MB
```
private static final long FIFTY_MB
```
    The number of bytes in 50 MB.
    
    See Also:
    Constant Field Values
  - ONE_GB
```
public static final long ONE_GB
```
    The number of bytes in a gigabyte.
    
    See Also:
    Constant Field Values
  - EMPTY_FILE_ARRAY
```
public static final File[] EMPTY_FILE_ARRAY
```
    An empty array of type File.
  - UTF8
```
private static final Charset UTF8
```
    The UTF-8 character set, used to decode octets in URLs.
- Constructor Detail
  - SomeFileUtils
```
public SomeFileUtils()
```
    Instances should NOT be constructed in standard programming.
- Method Detail
  - getTempDirectoryPath
```
public static String getTempDirectoryPath()
```
    Returns:
    the path to the system temporary directory.
  - getTempDirectory
```
public static File getTempDirectory()
```
    Returns a File representing the system temporary directory.
    
    Since:
    
    Commons IO 2.0
    
    Returns:
    the system temporary directory.
  - getUserDirectoryPath
```
public static String getUserDirectoryPath()
```
    Returns the path to the user's home directory.
    
    Since:
    
    Commons IO 2.0
    
    Returns:
    the path to the user's home directory.
  - getUserDirectory
```
public static File getUserDirectory()
```
    Returns a File representing the user's home directory.
    
    Since:
    
    Commons IO 2.0
    
    Returns:
    the user's home directory.
  - openInputStream
```
public static FileInputStream openInputStream(File file)
                                       throws IOException
```
    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.
    
    Since:
    
    Commons IO 1.3
    
    Parameters:
    file - the file to open for input, must not be null
    
    Returns:
    a new FileInputStream for the specified file
    
    Throws:
    
    FileNotFoundException - if the file does not exist
    
    IOException - if the file object is a directory
    
    IOException - if the file cannot be read
  - openOutputStream
```
public static FileOutputStream openOutputStream(File file)
                                         throws IOException
```
    Opens a FileOutputStream for the specified file, checking and creating the parent directory if net 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 net does not exist. The file will be created if net 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.
    
    Since:
    
    Commons IO 1.3
    
    Parameters:
    file - the file to open for output, must not be null
    
    Returns:
    a new FileOutputStream for the specified file
    
    Throws:
    
    IOException - if the file object is a directory
    
    IOException - if the file cannot be written to
    
    IOException - if a parent directory needs creating but that fails
  - byteCountToDisplaySize
```
public static String byteCountToDisplaySize(long size)
```
    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.
    
    Parameters:
    size - the number of bytes
    
    Returns:
    a human-readable display value (includes units - GB, MB, KB or bytes)
  - touch
```
public static void touch(File file)
                  throws IOException
```
    Implements the same behaviour as the "touch" utility on Unix. It creates a new file with size 0 or, if the file exists already, net is opened and closed without modifying net, 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.
    
    Parameters:
    file - the File to touch
    
    Throws:
    
    IOException - If an I/O problem occurs
  - convertFileCollectionToFileArray
```
public static File[] convertFileCollectionToFileArray(Collection<File> files)
```
    Converts a Collection containing java.io.File instanced into array representation. This is to account for the difference between File.listFiles() and FileUtils.listFiles().
    
    Parameters:
    files - a Collection containing java.io.File instances
    
    Returns:
    an array of java.io.File
  - contentEquals
```
public static boolean contentEquals(File file1,
                    File file2)
                             throws IOException
```
    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
    
    Parameters:
    file1 - the first file
    file2 - the second file
    
    Returns:
    true if the content of the files are equal or they both don't exist, false otherwise
    
    Throws:
    
    IOException - in case of an I/O error
  - toFile
```
public static File toFile(URL url)
```
    Convert from a URL to a File.
    From version 1.1 this method will decode the URL. Syntax such as file:///my%20docs/file.txt will be correctly decoded to /my docs/file.txt. Starting with version 1.5, this method uses UTF-8 to decode percent-encoded octets to characters. Additionally, malformed percent-encoded octets are handled leniently by passing them through literally.
    
    Parameters:
    url - the file URL to convert, null returns null
    
    Returns:
    the equivalent File object, or null if the URL's protocol is not file
  - decodeUrl
```
static String decodeUrl(String url)
```
    Decodes the specified URL as per RFC 3986, i.e. transforms percent-encoded octets to characters by decoding with the UTF-8 character set. This function is primarily intended for usage with URL which unfortunately does not enforce proper URLs. As such, this method will leniently accept invalid characters or malformed percent-encoded octets and simply pass them literally through to the result string. Except for rare edge cases, this will make unencoded URLs pass through unaltered.
    
    Parameters:
    url - The URL to decode, may be null.
    
    Returns:
    The decoded URL or null if the input was null.
  - toFiles
```
public static File[] toFiles(URL[] urls)
```
    Converts each of an array of URL to a File.
    Returns an array of the same size as the input. If the input is null, an empty array is returned. If the input contains null, the output array contains null at the same index.
    This method will decode the URL. Syntax such as file:///my%20docs/file.txt will be correctly decoded to /my docs/file.txt.
    
    Since:
    
    Commons IO 1.1
    
    Parameters:
    urls - the file URLs to convert, null returns empty array
    
    Returns:
    a non-null array of Files matching the input, with a null item if there was a null at that index in the input array
    
    Throws:
    
    IllegalArgumentException - if any file is not a URL file
    
    IllegalArgumentException - if any file is incorrectly encoded
  - toURLs
```
public static URL[] toURLs(File[] files)
                    throws IOException
```
    Converts each of an array of File to a URL.
    Returns an array of the same size as the input.
    
    Parameters:
    files - the files to convert
    
    Returns:
    an array of URLs matching the input
    
    Throws:
    
    IOException - if a file cannot be converted
  - copyFileToDirectory
```
public static void copyFileToDirectory(File srcFile,
                       File destDir)
                                throws IOException
```
    Copies a file to a directory 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 net does not exist. If the destination file exists, then this method will overwrite net.
    Note: This method tries to preserve the file's last modified date/times using File.setLastModified(long), however net is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.
    
    Parameters:
    srcFile - an existing file to copy, must not be null
    destDir - the directory to place the copy in, must not be null
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
    See Also:
    copyFile(File, File, boolean)
  - copyFileToDirectory
```
public static void copyFileToDirectory(File srcFile,
                       File destDir,
                       boolean preserveFileDate)
                                throws IOException
```
    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 net does not exist. If the destination file exists, then this method will overwrite net.
    Note: Setting preserveFileDate to true tries to preserve the file's last modified date/times using File.setLastModified(long), however net is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.
    
    Since:
    
    Commons IO 1.3
    
    Parameters:
    srcFile - an existing file to copy, must not be null
    destDir - the directory to place the copy in, must not be null
    preserveFileDate - true if the file date of the copy should be the same as the original
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
    See Also:
    copyFile(File, File, boolean)
  - copyFile
```
public static void copyFile(File srcFile,
            File destFile)
                     throws IOException
```
    Copies a file to a new location preserving the file date.
    This method copies the contents of the specified source file to the specified destination file. The directory holding the destination file is created if net does not exist. If the destination file exists, then this method will overwrite net.
    Note: This method tries to preserve the file's last modified date/times using File.setLastModified(long), however net is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.
    
    Parameters:
    srcFile - an existing file to copy, must not be null
    destFile - the new file, must not be null
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
    See Also:
    copyFileToDirectory(File, File)
  - copyFile
```
public static void copyFile(File srcFile,
            File destFile,
            boolean preserveFileDate)
                     throws IOException
```
    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 net does not exist. If the destination file exists, then this method will overwrite net.
    Note: Setting preserveFileDate to true tries to preserve the file's last modified date/times using File.setLastModified(long), however net is not guaranteed that the operation will succeed. If the modification operation fails, no indication is provided.
    
    Parameters:
    srcFile - an existing file to copy, must not be null
    destFile - the new file, must not be null
    preserveFileDate - true if the file date of the copy should be the same as the original
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
    See Also:
    copyFileToDirectory(File, File, boolean)
  - doCopyFile
```
private static void doCopyFile(File srcFile,
              File destFile,
              boolean preserveFileDate)
                        throws IOException
```
    Internal copy file method.
    
    Parameters:
    srcFile - the validated source file, must not be null
    destFile - the validated destination file, must not be null
    preserveFileDate - whether to preserve the file date
    
    Throws:
    
    IOException - if an error occurs
  - copyDirectoryToDirectory
```
public static void copyDirectoryToDirectory(File srcDir,
                            File destDir)
                                     throws IOException
```
    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 net 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 net is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.
    
    Since:
    
    Commons IO 1.2
    
    Parameters:
    srcDir - an existing directory to copy, must not be null
    destDir - the directory to place the copy in, must not be null
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
  - copyDirectory
```
public static void copyDirectory(File srcDir,
                 File destDir)
                          throws IOException
```
    Copies a whole directory to a new location preserving the file dates.
    This method copies the specified directory and all its child directories and files to the specified destination. The destination is the new location and name of the directory.
    The destination directory is created if net 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 net is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.
    
    Since:
    
    Commons IO 1.1
    
    Parameters:
    srcDir - an existing directory to copy, must not be null
    destDir - the new directory, must not be null
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
  - copyDirectory
```
public static void copyDirectory(File srcDir,
                 File destDir,
                 boolean preserveFileDate)
                          throws IOException
```
    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 net 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 net is not guaranteed that those operations will succeed. If the modification operation fails, no indication is provided.
    
    Since:
    
    Commons IO 1.1
    
    Parameters:
    srcDir - an existing directory to copy, must not be null
    destDir - the new directory, must not be null
    preserveFileDate - true if the file date of the copy should be the same as the original
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
  - copyDirectory
```
public static void copyDirectory(File srcDir,
                 File destDir,
                 FileFilter filter)
                          throws IOException
```
    Copies a filtered directory to a new location preserving the file dates.
    This method copies the contents of the specified source directory to within the specified destination directory.
    The destination directory is created if net 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 net 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
 FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY);
 
```
    Example: Copy directories and txt files
```
 // Create a filter for ".txt" files
 IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");
 IOFileFilter txtFiles =
         FileFilterUtils.andFileFilter(FileFileFilter.FILE, txtSuffixFilter);
 
 // Create a filter for either directories or ".txt" files
 FileFilter filter =
         FileFilterUtils.orFileFilter(DirectoryFileFilter.DIRECTORY, txtFiles);
 
 // Copy using the filter
 FileUtils.copyDirectory(srcDir, destDir, filter);
 
```
    Since:
    
    Commons IO 1.4
    
    Parameters:
    srcDir - an existing directory to copy, must not be null
    destDir - the new directory, must not be null
    filter - the filter to apply, null means copy all directories and files should be the same as the original
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
  - copyDirectory
```
public static void copyDirectory(File srcDir,
                 File destDir,
                 FileFilter filter,
                 boolean preserveFileDate)
                          throws IOException
```
    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 net 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 net 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
 FileUtils
         .copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY, false);
 
```
    Example: Copy directories and txt files
```
 // Create a filter for ".txt" files
 IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");
 IOFileFilter txtFiles =
         FileFilterUtils.andFileFilter(FileFileFilter.FILE, txtSuffixFilter);
 
 // Create a filter for either directories or ".txt" files
 FileFilter filter =
         FileFilterUtils.orFileFilter(DirectoryFileFilter.DIRECTORY, txtFiles);
 
 // Copy using the filter
 FileUtils.copyDirectory(srcDir, destDir, filter, false);
 
```
    Since:
    
    Commons IO 1.4
    
    Parameters:
    srcDir - an existing directory to copy, must not be null
    destDir - the new directory, must not be null
    filter - the filter to apply, null means copy all directories and files
    preserveFileDate - true if the file date of the copy should be the same as the original
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs during copying
  - doCopyDirectory
```
private static void doCopyDirectory(File srcDir,
                   File destDir,
                   FileFilter filter,
                   boolean preserveFileDate,
                   List<String> exclusionList)
                             throws IOException
```
    Internal copy directory method.
    
    Since:
    
    Commons IO 1.1
    
    Parameters:
    srcDir - the validated source directory, must not be null
    destDir - the validated destination directory, must not be null
    filter - the filter to apply, null means copy all directories and files
    preserveFileDate - whether to preserve the file date
    exclusionList - List of files and directories to exclude from the copy, may be null
    
    Throws:
    
    IOException - if an error occurs
  - copyURLToFile
```
public static void copyURLToFile(URL source,
                 File destination)
                          throws IOException
```
    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 net 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.
    
    Parameters:
    source - the URL to copy bytes from, must not be null
    destination - the non-directory File to write bytes to (possibly overwriting), must not be null
    
    Throws:
    
    IOException - if source URL cannot be opened
    
    IOException - if destination is a directory
    
    IOException - if destination cannot be written
    
    IOException - if destination needs creating but can't be
    
    IOException - if an IO error occurs during copying
  - copyURLToFile
```
public static void copyURLToFile(URL source,
                 File destination,
                 int connectionTimeout,
                 int readTimeout)
                          throws IOException
```
    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 net already exists.
    
    Since:
    
    Commons IO 2.0
    
    Parameters:
    source - the URL to copy bytes from, must not be null
    destination - the non-directory File to write bytes to (possibly overwriting), must not be null
    connectionTimeout - the number of milliseconds until this method will timeout if no connection could be established to the source
    readTimeout - the number of milliseconds until this method will timeout if no data could be read from the source
    
    Throws:
    
    IOException - if source URL cannot be opened
    
    IOException - if destination is a directory
    
    IOException - if destination cannot be written
    
    IOException - if destination needs creating but can't be
    
    IOException - if an IO error occurs during copying
  - copyInputStreamToFile
```
public static void copyInputStreamToFile(InputStream source,
                         File destination)
                                  throws IOException
```
    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 net already exists.
    
    Since:
    
    Commons IO 2.0
    
    Parameters:
    source - the InputStream to copy bytes from, must not be null
    destination - the non-directory File to write bytes to (possibly overwriting), must not be null
    
    Throws:
    
    IOException - if destination is a directory
    
    IOException - if destination cannot be written
    
    IOException - if destination needs creating but can't be
    
    IOException - if an IO error occurs during copying
  - deleteDirectory
```
public static void deleteDirectory(File directory)
                            throws IOException
```
    Deletes a directory recursively.
    
    Parameters:
    directory - directory to delete
    
    Throws:
    
    IOException - in case deletion is unsuccessful
  - deleteQuietly
```
public static boolean deleteQuietly(File file)
```
    Deletes a file, never throwing an exception. If file is a directory, delete net 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.
    Since:
    
    Commons IO 1.4
    
    Parameters:
    file - file or directory to delete, can be null
    
    Returns:
    true if the file or directory was deleted, otherwise false
  - cleanDirectory
```
public static void cleanDirectory(File directory)
                           throws IOException
```
    Cleans a directory without deleting net.
    
    Parameters:
    directory - directory to clean
    
    Throws:
    
    IOException - in case cleaning is unsuccessful
  - waitFor
```
public static boolean waitFor(File file,
              int seconds)
```
    Waits for NFS to propagate a file creation, imposing a timeout.
    This method repeatedly tests File.exists() until net returns true up to the maximum time specified in seconds.
    
    Parameters:
    file - the file to check, must not be null
    seconds - the maximum time in seconds to wait
    
    Returns:
    true if file exists
    
    Throws:
    
    NullPointerException - if the file is null
  - readFileToString
```
public static String readFileToString(File file,
                      String encoding)
                               throws IOException
```
    Reads the contents of a file into a String. The file is always closed.
    
    Parameters:
    file - the file to read, must not be null
    encoding - the encoding to use, null means platform default
    
    Returns:
    the file contents, never null
    
    Throws:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
  - readFileToString
```
public static String readFileToString(File file)
                               throws IOException
```
    Reads the contents of a file into a String using the default encoding for the VM. The file is always closed.
    
    Since:
    
    Commons IO 1.3.1
    
    Parameters:
    file - the file to read, must not be null
    
    Returns:
    the file contents, never null
    
    Throws:
    
    IOException - in case of an I/O error
  - readFileToByteArray
```
public static byte[] readFileToByteArray(File file)
                                  throws IOException
```
    Reads the contents of a file into a byte array. The file is always closed.
    
    Since:
    
    Commons IO 1.1
    
    Parameters:
    file - the file to read, must not be null
    
    Returns:
    the file contents, never null
    
    Throws:
    
    IOException - in case of an I/O error
  - readLines
```
public static List<String> readLines(File file,
                     String encoding)
                              throws IOException
```
    Reads the contents of a file line by line to a List of Strings. The file is always closed.
    
    Since:
    
    Commons IO 1.1
    
    Parameters:
    file - the file to read, must not be null
    encoding - the encoding to use, null means platform default
    
    Returns:
    the list of Strings representing each line in the file, never null
    
    Throws:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
  - readLines
```
public static List<String> readLines(File file)
                              throws IOException
```
    Reads the contents of a file line by line to a List of Strings using the default encoding for the VM. The file is always closed.
    
    Since:
    
    Commons IO 1.3
    
    Parameters:
    file - the file to read, must not be null
    
    Returns:
    the list of Strings representing each line in the file, never null
    
    Throws:
    
    IOException - in case of an I/O error
  - writeStringToFile
```
public static void writeStringToFile(File file,
                     String data,
                     String encoding)
                              throws IOException
```
    Writes a String to a file creating the file if net does not exist. NOTE: As from v1.3, the parent directories of the file will be created if they do not exist.
    
    Parameters:
    file - the file to write
    data - the content to write to the file
    encoding - the encoding to use, null means platform default
    
    Throws:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
  - writeStringToFile
```
public static void writeStringToFile(File file,
                     String data)
                              throws IOException
```
    Writes a String to a file creating the file if net does not exist using the default encoding for the VM.
    
    Parameters:
    file - the file to write
    data - the content to write to the file
    
    Throws:
    
    IOException - in case of an I/O error
  - write
```
public static void write(File file,
         CharSequence data)
                  throws IOException
```
    Writes a CharSequence to a file creating the file if net does not exist using the default encoding for the VM.
    
    Since:
    
    Commons IO 2.0
    
    Parameters:
    file - the file to write
    data - the content to write to the file
    
    Throws:
    
    IOException - in case of an I/O error
  - write
```
public static void write(File file,
         CharSequence data,
         String encoding)
                  throws IOException
```
    Writes a CharSequence to a file creating the file if net does not exist.
    
    Since:
    
    Commons IO 2.0
    
    Parameters:
    file - the file to write
    data - the content to write to the file
    encoding - the encoding to use, null means platform default
    
    Throws:
    
    IOException - in case of an I/O error
    
    UnsupportedEncodingException - if the encoding is not supported by the VM
  - writeByteArrayToFile
```
public static void writeByteArrayToFile(File file,
                        byte[] data)
                                 throws IOException
```
    Writes a byte array to a file creating the file if net does not exist.
    NOTE: As from v1.3, the parent directories of the file will be created if they do not exist.
    
    Since:
    
    Commons IO 1.1
    
    Parameters:
    file - the file to write to
    data - the content to write to the file
    
    Throws:
    
    IOException - in case of an I/O error
  - forceDelete
```
public static void forceDelete(File file)
                        throws IOException
```
    Deletes a file. If file is a directory, delete net 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)
    Parameters:
    file - file or directory to delete, must not be null
    
    Throws:
    
    NullPointerException - if the directory is null
    
    FileNotFoundException - if the file was not found
    
    IOException - in case deletion is unsuccessful
  - forceDeleteOnExit
```
public static void forceDeleteOnExit(File file)
                              throws IOException
```
    Schedules a file to be deleted when JVM exits. If file is directory delete net and all sub-directories.
    
    Parameters:
    file - file or directory to delete, must not be null
    
    Throws:
    
    NullPointerException - if the file is null
    
    IOException - in case deletion is unsuccessful
  - deleteDirectoryOnExit
```
private static void deleteDirectoryOnExit(File directory)
                                   throws IOException
```
    Schedules a directory recursively for deletion on JVM exit.
    
    Parameters:
    directory - directory to delete, must not be null
    
    Throws:
    
    NullPointerException - if the directory is null
    
    IOException - in case deletion is unsuccessful
  - cleanDirectoryOnExit
```
private static void cleanDirectoryOnExit(File directory)
                                  throws IOException
```
    Cleans a directory without deleting net.
    
    Parameters:
    directory - directory to clean, must not be null
    
    Throws:
    
    NullPointerException - if the directory is null
    
    IOException - in case cleaning is unsuccessful
  - forceMkdir
```
public static void forceMkdir(File directory)
                       throws IOException
```
    Makes a directory, including any necessary but nonexistent parent directories. If a file already exists with specified name but net is not a directory then an IOException is thrown. If the directory does not already exist and cannot be created, then an IOException is thrown.
    
    Parameters:
    directory - directory to create, must not be null
    
    Throws:
    
    NullPointerException - if the directory is null
    
    IOException - if the directory cannot be created or the file already exists but is not a directory
  - sizeOf
```
public static long sizeOf(File file)
```
    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.
    
    Since:
    
    Commons IO 2.0
    
    Parameters:
    file - the regular file or directory to return the size of (must not be null).
    
    Returns:
    the length of the file, or recursive size of the directory, provided (in bytes).
    
    Throws:
    
    NullPointerException - if the file is null
    
    IllegalArgumentException - if the file does not exist.
  - sizeOfDirectory
```
public static long sizeOfDirectory(File directory)
```
    Counts the size of a directory recursively (sum of the length of all files).
    
    Parameters:
    directory - directory to inspect, must not be null
    
    Returns:
    size of directory in bytes, 0 if directory is security restricted
    
    Throws:
    
    NullPointerException - if the directory is null
  - isFileNewer
```
public static boolean isFileNewer(File file,
                  File reference)
```
    Tests if the specified File is newer than the reference File.
    
    Parameters:
    file - the File of which the modification date must be compared, must not be null
    reference - the File of which the modification date is used, must not be null
    
    Returns:
    true if the File exists and has been modified more recently than the reference File
    
    Throws:
    
    IllegalArgumentException - if the file is null
    
    IllegalArgumentException - if the reference file is null or doesn't exist
  - isFileNewer
```
public static boolean isFileNewer(File file,
                  Date date)
```
    Tests if the specified File is newer than the specified Date.
    
    Parameters:
    file - the File of which the modification date must be compared, must not be null
    date - the date reference, must not be null
    
    Returns:
    true if the File exists and has been modified after the given Date.
    
    Throws:
    
    IllegalArgumentException - if the file is null
    
    IllegalArgumentException - if the date is null
  - isFileNewer
```
public static boolean isFileNewer(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, must not be null
    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.
    
    Throws:
    
    IllegalArgumentException - if the file is null
  - isFileOlder
```
public static boolean isFileOlder(File file,
                  File reference)
```
    Tests if the specified File is older than the reference File.
    
    Parameters:
    file - the File of which the modification date must be compared, must not be null
    reference - the File of which the modification date is used, must not be null
    
    Returns:
    true if the File exists and has been modified before the reference File
    
    Throws:
    
    IllegalArgumentException - if the file is null
    
    IllegalArgumentException - if the reference file is null or doesn't exist
  - isFileOlder
```
public static boolean isFileOlder(File file,
                  Date date)
```
    Tests if the specified File is older than the specified Date.
    
    Parameters:
    file - the File of which the modification date must be compared, must not be null
    date - the date reference, must not be null
    
    Returns:
    true if the File exists and has been modified before the given Date.
    
    Throws:
    
    IllegalArgumentException - if the file is null
    
    IllegalArgumentException - if the date is null
  - isFileOlder
```
public static boolean isFileOlder(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, must not be null
    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 before the given time reference.
    
    Throws:
    
    IllegalArgumentException - if the file is null
  - moveDirectory
```
public static void moveDirectory(File srcDir,
                 File destDir)
                          throws IOException
```
    Moves a directory.
    When the destination directory is on another file system, do a "copy and delete".
    
    Since:
    
    Commons IO 1.4
    
    Parameters:
    srcDir - the directory to be moved
    destDir - the destination directory
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs moving the file
  - moveDirectoryToDirectory
```
public static void moveDirectoryToDirectory(File src,
                            File destDir,
                            boolean createDestDir)
                                     throws IOException
```
    Moves a directory to another directory.
    
    Since:
    
    Commons IO 1.4
    
    Parameters:
    src - the file to be moved
    destDir - the destination file
    createDestDir - If true create the destination directory, otherwise if false throw an IOException
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs moving the file
  - moveFile
```
public static void moveFile(File srcFile,
            File destFile)
                     throws IOException
```
    Moves a file.
    When the destination file is on another file system, do a "copy and delete".
    
    Since:
    
    Commons IO 1.4
    
    Parameters:
    srcFile - the file to be moved
    destFile - the destination file
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs moving the file
  - moveFileToDirectory
```
public static void moveFileToDirectory(File srcFile,
                       File destDir,
                       boolean createDestDir)
                                throws IOException
```
    Moves a file to a directory.
    
    Since:
    
    Commons IO 1.4
    
    Parameters:
    srcFile - the file to be moved
    destDir - the destination file
    createDestDir - If true create the destination directory, otherwise if false throw an IOException
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs moving the file
  - moveToDirectory
```
public static void moveToDirectory(File src,
                   File destDir,
                   boolean createDestDir)
                            throws IOException
```
    Moves a file or directory to the destination directory.
    When the destination is on another file system, do a "copy and delete".
    
    Since:
    
    Commons IO 1.4
    
    Parameters:
    src - the file or directory to be moved
    destDir - the destination directory
    createDestDir - If true create the destination directory, otherwise if false throw an IOException
    
    Throws:
    
    NullPointerException - if source or destination is null
    
    IOException - if source or destination is invalid
    
    IOException - if an IO error occurs moving the file
  - isSymlink
```
public static boolean isSymlink(File file)
                         throws IOException
```
    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.
    
    Since:
    
    Commons IO 2.0
    
    Parameters:
    file - the file to check
    
    Returns:
    true if the file is a Symbolic Link
    
    Throws:
    
    IOException - if an IO error occurs while checking the file

Class SomeFileUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE_KB

ONE_MB

FIFTY_MB

ONE_GB

EMPTY_FILE_ARRAY

UTF8

Constructor Detail

SomeFileUtils

Method Detail

getTempDirectoryPath

getTempDirectory

getUserDirectoryPath

getUserDirectory

openInputStream

openOutputStream

byteCountToDisplaySize

touch

convertFileCollectionToFileArray

contentEquals

toFile

decodeUrl

toFiles

toURLs

copyFileToDirectory

copyFileToDirectory

copyFile

copyFile

doCopyFile

copyDirectoryToDirectory

copyDirectory

copyDirectory

copyDirectory

Example: Copy directories only

Example: Copy directories and txt files

copyDirectory

Example: Copy directories only

Example: Copy directories and txt files

doCopyDirectory

copyURLToFile

copyURLToFile

copyInputStreamToFile

deleteDirectory

deleteQuietly

cleanDirectory

waitFor

readFileToString

readFileToString

readFileToByteArray

readLines

readLines

writeStringToFile

writeStringToFile

write

write

writeByteArrayToFile

forceDelete

forceDeleteOnExit

deleteDirectoryOnExit

cleanDirectoryOnExit

forceMkdir

sizeOf

sizeOfDirectory

isFileNewer

isFileNewer

isFileNewer

isFileOlder

isFileOlder

isFileOlder

moveDirectory

moveDirectoryToDirectory

moveFile

moveFileToDirectory

moveToDirectory

isSymlink