com.tangosol.io

Class FileHelper

java.lang.Object

com.tangosol.io.FileHelper

public class FileHelper
extends Object

A Collection of helper methods for files.

Author:

jh 2012.07.13

Constructor Summary

Constructors

Constructor and Description
FileHelper()

Method Summary

Modifier and Type	Method and Description
static void	copyDir(File fileDirFrom, File fileDirTo) Create a deep copy of the specified directory into the specified target directory.
static void	copyFile(File fileFrom, File fileTo) Copy the specified file according to the source and destination File objects preserving the time-stamp of the source.
static File	createTempDir() Create a unique temporary directory.
static void	deleteDir(File fileDir) Delete a directory recursively.
static void	deleteDirSilent(File fileDir) Recursively delete a directory suppressing any raised exceptions.
static File	ensureDir(File file) Validate that the given File represents a directory, creating it if it doesn't already exist.
static FileLock	lockFile(File file) Obtain an exclusive lock on the specified file.
static void	moveDir(File fileDirFrom, File fileDirTo) Move the specified directory to the specified destination path.
static void	moveFile(File fileFrom, File fileTo) Move the specified file to the specified destination path.
static long	sizeDir(File fileDir) Return the approximate disk usage in bytes for a given directory.
static String	toFilename(String sName) Given a string, return a derivative version that is safe to use for a filename.
static void	unlockFile(FileLock lock) Release an exclusive lock on a file.
static void	validateDir(File file) Validate that the given File exists and represents a directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileHelper

public FileHelper()

Method Detail

toFilename

public static String toFilename(String sName)

Given a string, return a derivative version that is safe to use for a filename.

Parameters:

sName - the string

Returns:

a derivative of the given string that is safe to use as a filename (may be the same as the string supplied)

ensureDir

public static File ensureDir(File file)
                      throws IOException

Validate that the given File represents a directory, creating it if it doesn't already exist.

Parameters:

file - the File to check

Returns:

the validated File

Throws:

IOException - on error creating the directory

validateDir

public static void validateDir(File file)
                        throws IOException

Validate that the given File exists and represents a directory.

Parameters:

file - the File to check

Throws:

IOException - if the given File doesn't exist or doesn't represent a directory

copyDir

public static void copyDir(File fileDirFrom,
                           File fileDirTo)
                    throws IOException

Create a deep copy of the specified directory into the specified target directory.

Parameters:

fileDirFrom - the directory to copy from

fileDirTo - the directory to copy into

Throws:

IOException - if an error occurred copying the directory

deleteDir

public static void deleteDir(File fileDir)
                      throws IOException

Delete a directory recursively.

Parameters:

fileDir - directory to delete

Throws:

IOException - if an error occurred deleting the directory

deleteDirSilent

public static void deleteDirSilent(File fileDir)

Recursively delete a directory suppressing any raised exceptions.

Parameters:

fileDir - directory to delete

moveDir

public static void moveDir(File fileDirFrom,
                           File fileDirTo)
                    throws IOException

Move the specified directory to the specified destination path.

Parameters:

fileDirFrom - the directory to move

fileDirTo - the destination path

Throws:

IOException - if an error occurred moving the directory

createTempDir

public static File createTempDir()
                          throws IOException

Create a unique temporary directory.

Returns:

a unique temporary directory

Throws:

IOException

sizeDir

public static long sizeDir(File fileDir)

Return the approximate disk usage in bytes for a given directory. Note the size may differ from the actual size on the file system due to compression, support for sparse files, or other reasons.

Parameters:

fileDir - the directory to size

Returns:

the number of total bytes used by the files in the directory

copyFile

public static void copyFile(File fileFrom,
                            File fileTo)
                     throws IOException

Copy the specified file according to the source and destination File objects preserving the time-stamp of the source.

Parameters:

fileFrom - the File to copy from

fileTo - the File to copy to

Throws:

IOException - if an error occurred copying the file

moveFile

public static void moveFile(File fileFrom,
                            File fileTo)
                     throws IOException

Move the specified file to the specified destination path.

Parameters:

fileFrom - the file to move

fileTo - the destination path

Throws:

IOException - if an error occurred moving the file

lockFile

public static FileLock lockFile(File file)

Obtain an exclusive lock on the specified file. The lock should be released with the unlockFile method.

Parameters:

file - the file to lock

Returns:

a FileLock if an exclusive lock was obtained, null otherwise

unlockFile

public static void unlockFile(FileLock lock)

Release an exclusive lock on a file.

Parameters:

lock - the exclusive lock to release