org.apache.activemq.apollo.util

Class IOHelper

java.lang.Object

org.apache.activemq.apollo.util.IOHelper

public final class IOHelper
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IOHelper.HardLinkStrategy
static interface	IOHelper.SyncStrategy

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
static void	close(InputStream in)
static void	close(OutputStream out)
static void	close(Writer out)
static void	copyFile(File src, File dest)
static void	copyInputStream(InputStream in, OutputStream out)
static boolean	deleteChildren(File parent)
static boolean	deleteFile(File fileToDelete)
static CLibrary	getCLibrary()
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 Kernel32Library	getKernel32Library()
static void	hardlink(File source, File target)
static void	mkdirs(File dir)
static void	moveFile(File src, File targetDirectory)
static byte[]	readBytes(File path)
static byte[]	readBytes(InputStream in)
static String	readText(File path)
static String	readText(File path, String encoding)
static String	readText(InputStream in)
static String	readText(InputStream in, String encoding)
static void	sync(FileDescriptor fd)
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.
static void	writeBinaryFile(File path, byte[] contents)
static void	writeText(File path, String text)
static void	writeText(File path, String text, String encoding)

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:

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:

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

copyFile

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

Throws:

IOException

readText

public static String readText(File path)
                       throws IOException

Throws:

IOException

readText

public static String readText(File path,
              String encoding)
                       throws IOException

Throws:

IOException

readText

public static String readText(InputStream in)
                       throws IOException

Throws:

IOException

readText

public static String readText(InputStream in,
              String encoding)
                       throws IOException

Throws:

IOException

readBytes

public static byte[] readBytes(File path)
                        throws IOException

Throws:

IOException

readBytes

public static byte[] readBytes(InputStream in)
                        throws IOException

Throws:

IOException

writeText

public static void writeText(File path,
             String text)
                      throws IOException

Throws:

IOException

writeText

public static void writeText(File path,
             String text,
             String encoding)
                      throws IOException

Throws:

IOException

writeBinaryFile

public static void writeBinaryFile(File path,
                   byte[] contents)
                            throws IOException

Throws:

IOException

copyInputStream

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

Throws:

IOException

close

public static void close(Writer out)

close

public static void close(OutputStream out)

close

public static void close(InputStream in)

mkdirs

public static void mkdirs(File dir)
                   throws IOException

Throws:

IOException

sync

public static void sync(FileDescriptor fd)
                 throws IOException

Throws:

IOException

hardlink

public static void hardlink(File source,
            File target)
                     throws IOException

Throws:

IOException

getCLibrary

public static CLibrary getCLibrary()
                            throws ClassNotFoundException,
                                   IllegalAccessException,
                                   NoSuchFieldException

Throws:

ClassNotFoundException

IllegalAccessException

NoSuchFieldException

getKernel32Library

public static Kernel32Library getKernel32Library()
                                          throws ClassNotFoundException,
                                                 IllegalAccessException,
                                                 NoSuchFieldException

Throws:

ClassNotFoundException

IllegalAccessException

NoSuchFieldException