Package org.apache.activemq.util

Class IOHelper

java.lang.Object

org.apache.activemq.util.IOHelper

public final class IOHelper
extends Object

Collection of File and Folder utility methods.

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	MAX_DIR_NAME_LENGTH
protected static int	MAX_FILE_NAME_LENGTH

Method Summary

Modifier and Type	Method	Description
static void	copyFile(File src, File dest)
static void	copyFile(File src, File dest, FilenameFilter filter)
static void	copyInputStream(InputStream in, OutputStream out)
static void	copySingleFile(File src, File dest)
static boolean	delete(File top)
static boolean	deleteChildren(File parent)
static boolean	deleteFile(File fileToDelete)
static String	getDefaultDataDirectory()
static String	getDefaultDirectoryPrefix()	Allows a system property to be used to overload the default data directory which can be useful for forcing the test cases to use a target/ prefix
static String	getDefaultStoreDirectory()
static int	getMaxDirNameLength()
static int	getMaxFileNameLength()
static void	mkdirs(File dir)
static void	moveFile(File src, File targetDirectory)
static void	moveFiles(File srcDirectory, File targetDirectory, FilenameFilter filter)
static String	toFileSystemDirectorySafeName(String name)	Converts any string into a string that is safe to use as a file name.
static String	toFileSystemSafeName(String name)
static String	toFileSystemSafeName(String name, boolean dirSeparators, int maxFileLength)	Converts any string into a string that is safe to use as a file name.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_DIR_NAME_LENGTH

protected static final int MAX_DIR_NAME_LENGTH

MAX_FILE_NAME_LENGTH

protected static final int MAX_FILE_NAME_LENGTH

Method Detail

getDefaultDataDirectory

public static String getDefaultDataDirectory()

getDefaultStoreDirectory

public static String getDefaultStoreDirectory()

getDefaultDirectoryPrefix

public static String getDefaultDirectoryPrefix()

Allows a system property to be used to overload the default data directory which can be useful for forcing the test cases to use a target/ prefix

toFileSystemDirectorySafeName

public static String toFileSystemDirectorySafeName(String name)

Converts any string into a string that is safe to use as a file name. The result will only include ascii characters and numbers, and the "-","_", and "." characters.

Parameters:

name -

Returns:

safe name of the directory

toFileSystemSafeName

public static String toFileSystemSafeName(String name)

toFileSystemSafeName

public static String toFileSystemSafeName(String name,
                                          boolean dirSeparators,
                                          int maxFileLength)

Converts any string into a string that is safe to use as a file name. The result will only include ascii characters and numbers, and the "-","_", and "." characters.

Parameters:

name -

dirSeparators -

maxFileLength -

Returns:

file system safe name

delete

public static boolean delete(File top)

deleteFile

public static boolean deleteFile(File fileToDelete)

deleteChildren

public static boolean deleteChildren(File parent)

moveFile

public static void moveFile(File src,
                            File targetDirectory)
                     throws IOException

Throws:

IOException

moveFiles

public static void moveFiles(File srcDirectory,
                             File targetDirectory,
                             FilenameFilter filter)
                      throws IOException

Throws:

IOException

copyFile

public static void copyFile(File src,
                            File dest)
                     throws IOException

Throws:

IOException

copyFile

public static void copyFile(File src,
                            File dest,
                            FilenameFilter filter)
                     throws IOException

Throws:

IOException

copySingleFile

public static void copySingleFile(File src,
                                  File dest)
                           throws IOException

Throws:

IOException

copyInputStream

public static void copyInputStream(InputStream in,
                                   OutputStream out)
                            throws IOException

Throws:

IOException

getMaxDirNameLength

public static int getMaxDirNameLength()

getMaxFileNameLength

public static int getMaxFileNameLength()

mkdirs

public static void mkdirs(File dir)
                   throws IOException

Throws:

IOException