com.aoindustries.io

Class FileUtils

java.lang.Object

com.aoindustries.io.FileUtils

public final class FileUtils
extends Object

File utilities.

Method Summary

Modifier and Type	Method and Description
static File	checkIsDirectory(File directory) Ensures that the file is a directory.
static boolean	contentEquals(File file, byte[] contents) Compares the contents of a file to the provided array.
static boolean	contentEquals(File file1, File file2) Compares the contents of two files, not supporting directories.
static int	contentHashCode(File file) Computes a hash code of the file contents, consistent with Arrays.hashCode(byte[]).
static long	copy(File from, Appendable out) Copies a file to an appendable in system default locale.
static long	copy(File from, File to) Copies one file over another, possibly creating if needed.
static long	copy(File from, OutputStream out) Copies a file to an output stream.
static long	copy(File from, Writer out) Copies a file to a writer in system default locale.
static void	copyRecursive(File from, File to) Recursively copies source to destination.
static void	copyRecursive(File from, File to, FileFilter fileFilter) Recursively copies source to destination.
static File	copyToTempFile(InputStream in, String prefix, String suffix) Copies a stream to a newly created temporary file.
static File	copyToTempFile(InputStream in, String prefix, String suffix, File directory) Copies a stream to a newly created temporary file.
static File	createTempDirectory(String prefix, String suffix) Creates a temporary directory.
static File	createTempDirectory(String prefix, String suffix, File directory) Creates a temporary directory.
static void	delete(File file) Deletes the provided file, throwing IOException if unsuccessful.
static void	deleteRecursive(File file) Recursively deletes the provided file, being careful to not follow symbolic links (but there are still unavoidable race conditions).
static String	getExtension(String path) Gets the extension from the path, not including any period.
static File	getFile(URL url, String urlEncoding, boolean deleteOnExit) Gets a File for a URL, retrieving the contents into a temporary file if needed.
static File	mkdir(File directory) Makes a directory.
static File	mkdirs(File directory) Makes a directory and all of its parents.
static String	readFileAsString(File file) Reads the contents of a File and returns as a String.
static void	rename(File from, File to) Atomically renames one file to another, throwing IOException when unsuccessful.
static void	renameAllowNonAtomic(File from, File to) Renames one file to another, throwing IOException when unsuccessful.

Methods inherited from class java.lang.Object

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

Method Detail

delete

public static void delete(File file)
                   throws IOException

Deletes the provided file, throwing IOException if unsuccessful.

Throws:

IOException

deleteRecursive

public static void deleteRecursive(File file)
                            throws IOException

Recursively deletes the provided file, being careful to not follow symbolic links (but there are still unavoidable race conditions).

Throws:

IOException

contentEquals

public static boolean contentEquals(File file,
                                    byte[] contents)
                             throws IOException

Compares the contents of a file to the provided array.

Throws:

IOException

contentEquals

public static boolean contentEquals(File file1,
                                    File file2)
                             throws IOException

Compares the contents of two files, not supporting directories.

Throws:

IOException

contentHashCode

public static int contentHashCode(File file)
                           throws IOException

Computes a hash code of the file contents, consistent with Arrays.hashCode(byte[]).

Throws:

IOException

See Also:

Arrays.hashCode(byte[])

createTempDirectory

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

Creates a temporary directory.

Throws:

IOException

createTempDirectory

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

Creates a temporary directory.

Throws:

IOException

copyToTempFile

public static File copyToTempFile(InputStream in,
                                  String prefix,
                                  String suffix)
                           throws IOException

Copies a stream to a newly created temporary file.

Throws:

IOException

copyToTempFile

public static File copyToTempFile(InputStream in,
                                  String prefix,
                                  String suffix,
                                  File directory)
                           throws IOException

Copies a stream to a newly created temporary file.

Throws:

IOException

mkdir

public static File mkdir(File directory)
                  throws IOException

Makes a directory. The directory must not already exist.

Returns:

The directory itself.

Throws:

IOException - if mkdir fails.

mkdirs

public static File mkdirs(File directory)
                   throws IOException

Makes a directory and all of its parents. The directory must not already exist.

Returns:

The directory itself.

Throws:

IOException - if mkdirs fails.

checkIsDirectory

public static File checkIsDirectory(File directory)
                             throws IOException

Ensures that the file is a directory.

Returns:

The directory itself.

Throws:

IOException - if not a directory

copy

public static long copy(File from,
                        File to)
                 throws IOException

Copies one file over another, possibly creating if needed.

Returns:

the number of bytes copied

Throws:

IOException

copy

public static long copy(File from,
                        OutputStream out)
                 throws IOException

Copies a file to an output stream.

Returns:

the number of bytes copied

Throws:

IOException

copy

public static long copy(File from,
                        Writer out)
                 throws IOException

Copies a file to a writer in system default locale.

Returns:

the number of characters copied

Throws:

IOException

copy

public static long copy(File from,
                        Appendable out)
                 throws IOException

Copies a file to an appendable in system default locale.

Returns:

the number of characters copied

Throws:

IOException

copyRecursive

public static void copyRecursive(File from,
                                 File to)
                          throws IOException

Recursively copies source to destination. Destination must not exist.

Throws:

IOException

copyRecursive

public static void copyRecursive(File from,
                                 File to,
                                 FileFilter fileFilter)
                          throws IOException

Recursively copies source to destination. Destination must not exist.

Throws:

IOException

getExtension

public static String getExtension(String path)

Gets the extension from the path, not including any period. If no extension, returns an empty string.

getFile

public static File getFile(URL url,
                           String urlEncoding,
                           boolean deleteOnExit)
                    throws IOException

Gets a File for a URL, retrieving the contents into a temporary file if needed.

Parameters:

deleteOnExit - when true, any newly created temp file will be flagged for deleteRecursive of exit

Throws:

IOException

rename

public static void rename(File from,
                          File to)
                   throws IOException

Atomically renames one file to another, throwing IOException when unsuccessful.

Throws:

IOException

renameAllowNonAtomic

public static void renameAllowNonAtomic(File from,
                                        File to)
                                 throws IOException

Renames one file to another, throwing IOException when unsuccessful. Allow a non-atomic delete/rename pair when the underlying system is unable to rename one file over another, such as in Microsoft Windows.

When the delete or rename fails, will retry up to ten times with increasing delay between each attempt.

Throws:

IOException

readFileAsString

public static String readFileAsString(File file)
                               throws IOException

Reads the contents of a File and returns as a String.

Throws:

IOException