com.cloudhopper.commons.util

Class FileUtil

java.lang.Object

com.cloudhopper.commons.util.FileUtil

public class FileUtil
extends Object

Utility class for handling Files. NOTE: Some code copied from the JXL project.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileUtil.FileNameDateTimeComparator Class to compare Files by their embedded DateTimes.

Method Summary

Methods

Modifier and Type	Method and Description
static void	copy(File sourceFile, File targetFile) Copy the source file to the target file.
static boolean	copy(File sourceFile, File targetFile, boolean overwrite) Copy the source file to the target file while optionally permitting an overwrite to occur in case the target file already exists.
static boolean	equals(File file1, File file2) Tests whether the contents of two files equals each other by performing a byte-by-byte comparison.
static File[]	findFiles(File dir, FileFilter filter) Finds all files (non-recursively) in a directory based on the FileFilter.
static boolean	isValidFileExtension(String extension) Checks if the extension is valid.
static String	parseFileExtension(String filename) Parse the filename and return the file extension.

Methods inherited from class java.lang.Object

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

Method Detail

equals

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

Tests whether the contents of two files equals each other by performing a byte-by-byte comparison. Each byte must match each other in both files.

Parameters:

file1 - The file to compare

file2 - The other file to compare

Returns:

True if file contents are equal, otherwise false.

Throws:

IOException - Thrown if there is an underlying IO error while attempt to compare the bytes.

isValidFileExtension

public static boolean isValidFileExtension(String extension)

Checks if the extension is valid. This method only permits letters, digits, and an underscore character.

Parameters:

extension - The file extension to validate

Returns:

True if its valid, otherwise false

parseFileExtension

public static String parseFileExtension(String filename)

Parse the filename and return the file extension. For example, if the file is "app.2006-10-10.log", then this method will return "log". Will only return the last file extension. For example, if the filename ends with ".log.gz", then this method will return "gz"

Parameters:

String - to process containing the filename

Returns:

The file extension (without leading period) such as "gz" or "txt" or null if none exists.

findFiles

public static File[] findFiles(File dir,
               FileFilter filter)
                        throws FileNotFoundException

Finds all files (non-recursively) in a directory based on the FileFilter. This method is slightly different than the JDK File.listFiles() version since it throws an error if the directory does not exist or is not a directory. Also, this method only finds files and will skip including directories.

Throws:

FileNotFoundException

copy

public static void copy(File sourceFile,
        File targetFile)
                 throws FileAlreadyExistsException,
                        IOException

Copy the source file to the target file.

Parameters:

sourceFile - The source file to copy from

targetFile - The target file to copy to

Throws:

FileAlreadyExistsException - Thrown if the target file already exists. This exception is a subclass of IOException, so catching an IOException is enough if you don't care about this specific reason.

IOException - Thrown if an error during the copy

copy

public static boolean copy(File sourceFile,
           File targetFile,
           boolean overwrite)
                    throws FileAlreadyExistsException,
                           IOException

Copy the source file to the target file while optionally permitting an overwrite to occur in case the target file already exists.

Parameters:

sourceFile - The source file to copy from

targetFile - The target file to copy to

Returns:

True if an overwrite occurred, otherwise false.

Throws:

FileAlreadyExistsException - Thrown if the target file already exists and an overwrite is not permitted. This exception is a subclass of IOException, so catching an IOException is enough if you don't care about this specific reason.

IOException - Thrown if an error during the copy