com.izforge.izpack.util.file

Class FileUtils

java.lang.Object

com.izforge.izpack.util.file.FileUtils

public class FileUtils
extends Object

This class also encapsulates methods which allow Files to be referred to using abstract path names which are translated to native system file paths at runtime as well as copying files or setting their last modification time.

Field Summary

Fields

Modifier and Type	Field and Description
static long	FAT_FILE_TIMESTAMP_GRANULARITY The granularity of timestamps under FAT.
static long	UNIX_FILE_TIMESTAMP_GRANULARITY The granularity of timestamps under Unix.

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static void	copyFile(File sourceFile, File destFile, boolean overwrite, boolean preserveLastModified) Convenience method to copy a file from a source to a destination specifying if token filtering must be used, if filter chains must be used, if source files may overwrite newer destination files and the last modified time of destFile file should be made equal to the last modified time of sourceFile.
static void	copyFile(String sourceFile, String destFile, boolean overwrite, boolean preserveLastModified) Convenience method to copy a file from a source to a destination.
static File	createTempDirectory(String prefix, File directory) Create a temporary directory.
static long	getFileTimestampGranularity() Get the granularity of file timestamps.
static File	getParentFile(File f) This was originally an emulation of File.getParentFile() for JDK 1.1, but it is now implemented using that method (Ant 1.6.3 onwards).
static boolean	isSymbolicLink(File parent, String name) Checks whether a given file is a symbolic link.
static String	removeLeadingPath(File leading, File path) Removes a leading path from a second path.
static File	resolveFile(File file, String filename) Interpret the filename as a file relative to the given file unless the filename already represents an absolute filename.

Methods inherited from class java.lang.Object

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

Field Detail

FAT_FILE_TIMESTAMP_GRANULARITY

public static final long FAT_FILE_TIMESTAMP_GRANULARITY

The granularity of timestamps under FAT.

See Also:

Constant Field Values

UNIX_FILE_TIMESTAMP_GRANULARITY

public static final long UNIX_FILE_TIMESTAMP_GRANULARITY

The granularity of timestamps under Unix.

See Also:

Constant Field Values

Constructor Detail

FileUtils

public FileUtils()

Method Detail

copyFile

public static void copyFile(String sourceFile,
                            String destFile,
                            boolean overwrite,
                            boolean preserveLastModified)
                     throws IOException

Convenience method to copy a file from a source to a destination. No filtering is performed.

Parameters:

sourceFile - Name of file to copy from. Must not be null.

destFile - Name of file to copy to. Must not be null.

Throws:

IOException - if the copying fails.

copyFile

public static void copyFile(File sourceFile,
                            File destFile,
                            boolean overwrite,
                            boolean preserveLastModified)
                     throws IOException

Convenience method to copy a file from a source to a destination specifying if token filtering must be used, if filter chains must be used, if source files may overwrite newer destination files and the last modified time of destFile file should be made equal to the last modified time of sourceFile.

Parameters:

sourceFile - the file to copy from. Must not be null.

destFile - the file to copy to. Must not be null.

overwrite - Whether or not the destination file should be overwritten if it already exists.

preserveLastModified - Whether or not the last modified time of the resulting file should be set to that of the source file.

Throws:

IOException - if the copying fails.

resolveFile

public static File resolveFile(File file,
                               String filename)
                        throws Exception

Interpret the filename as a file relative to the given file unless the filename already represents an absolute filename.

Parameters:

file - the "reference" file for relative paths. This instance must be an absolute file and must not contain "./" or "../" sequences (same for \ instead of /). If it is null, this call is equivalent to new java.io.File(filename).

filename - a file name.

Returns:

an absolute file that doesn't contain "./" or "../" sequences and uses the correct separator for the current platform.

Throws:

Exception

getParentFile

public static File getParentFile(File f)

This was originally an emulation of File.getParentFile() for JDK 1.1, but it is now implemented using that method (Ant 1.6.3 onwards).

Parameters:

f - the file whose parent is required.

Returns:

the given file's parent, or null if the file does not have a parent.

isSymbolicLink

public static boolean isSymbolicLink(File parent,
                                     String name)
                              throws IOException

Checks whether a given file is a symbolic link.

It doesn't really test for symbolic links but whether the canonical and absolute paths of the file are identical--this may lead to false positives on some platforms.

Parameters:

parent - the parent directory of the file to test

name - the name of the file to test.

Returns:

true if the file is a symbolic link.

Throws:

IOException - on error.

removeLeadingPath

public static String removeLeadingPath(File leading,
                                       File path)
                                throws Exception

Removes a leading path from a second path.

Parameters:

leading - The leading path, must not be null, must be absolute.

path - The path to remove from, must not be null, must be absolute.

Returns:

path's normalized absolute if it doesn't start with leading; path's path with leading's path removed otherwise.

Throws:

Exception

getFileTimestampGranularity

public static long getFileTimestampGranularity()

Get the granularity of file timestamps. The choice is made based on OS, which is incorrect--it should really be by filesystem. We do not have an easy way to probe for file systems, however.

Returns:

the difference, in milliseconds, which two file timestamps must have in order for the two files to be given a creation order.

createTempDirectory

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

Create a temporary directory.

Parameters:

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

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

Returns:

a new temporary directory

Throws:

IOException - if the creation of the directory fails