org.jboss.util.file
Class Files

java.lang.Object
  org.jboss.util.file.Files

public final class Files
extends Object

A collection of file utilities.

Version:

$Revision: 1.4.6.5 $

Author:

Jason Dillon, Scott Stark, Dimitris Andreadis

Field Summary

static int

DEFAULT_BUFFER_SIZE The default size of the copy buffer.

Constructor Summary

Files()

Method Summary

static void	copy(File source, File target) Copy a file.
static void	copy(File source, File target, byte[] buff) Copy a file.
static void	copy(File source, File target, int size) Copy a file.
static void	copy(URL src, File dest) Copy a remote/local URL to a local file
static String	decodeFileName(String name) Used to decode a file system friendly filename produced by encodeFileName() method, above.
static String	decodeFileName(String name, char escape) See decodeFileName(String) above.
static boolean	delete(File dir) Delete a file, or a directory and all of its contents.
static boolean	delete(String dirname) Delete a file or directory and all of its contents.
static boolean	deleteContaining(String filename) Delete a directory contaning the given file and all its contents.
static String	encodeFileName(String name) Used to encode any string into a string that is safe to use as a file name on most operating systems.
static String	encodeFileName(String name, char escape) See encodeFileName(String) above.
static String	findRelativePath(String base, String path) Build a relative path to the given base path.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

The default size of the copy buffer.

See Also:

Constant Field Values

Constructor Detail

Files

public Files()

Method Detail

delete

public static boolean delete(File dir)

Delete a file, or a directory and all of its contents.

Parameters:

dir - The directory or file to delete.

Returns:

True if all delete operations were successfull.

delete

public static boolean delete(String dirname)

Delete a file or directory and all of its contents.

Parameters:

dirname - The name of the file or directory to delete.

Returns:

True if all delete operations were successfull.

deleteContaining

public static boolean deleteContaining(String filename)

Delete a directory contaning the given file and all its contents.

Parameters:

filename - a file or directory in the containing directory to delete

Returns:

true if all delete operations were successfull, false if any delete failed.

copy

public static void copy(File source,
                        File target,
                        byte[] buff)
                 throws IOException

Copy a file.

Parameters:

source - Source file to copy.

target - Destination target file.

buff - The copy buffer.

Throws:

IOException - Failed to copy file.

copy

public static void copy(File source,
                        File target,
                        int size)
                 throws IOException

Copy a file.

Parameters:

source - Source file to copy.

target - Destination target file.

size - The size of the copy buffer.

Throws:

IOException - Failed to copy file.

copy

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

Copy a file.

Parameters:

source - Source file to copy.

target - Destination target file.

Throws:

IOException - Failed to copy file.

copy

public static void copy(URL src,
                        File dest)
                 throws IOException

Copy a remote/local URL to a local file

Parameters:

src - the remote or local URL

dest - the local file

Throws:

IOException - upon error

encodeFileName

public static String encodeFileName(String name)

Used to encode any string into a string that is safe to use as a file name on most operating systems. Use decodeFileName() to get back the original string. Copied by Adrian's org.jboss.mq.pm.file.PersistenceManager and adapted to use hex instead of decimal digits

Parameters:

name - the filename to encode

Returns:

a filesystem-friendly filename

decodeFileName

public static String decodeFileName(String name)

Used to decode a file system friendly filename produced by encodeFileName() method, above. Copied by Adrian's org.jboss.mq.pm.file.PersistenceManager and adapted to use hex instead of decimal digits Note: Decoding will not work if encoding produced multi-byte encoded characters. If this is truly needed we'll have to revise the encoding.

Parameters:

name - the filename to decode

Returns:

the original name

encodeFileName

public static String encodeFileName(String name,
                                    char escape)

See encodeFileName(String) above.

Parameters:

name - the filename to encode

escape - the escape character to use

Returns:

a filesystem-friendly filename

decodeFileName

public static String decodeFileName(String name,
                                    char escape)

See decodeFileName(String) above.

Parameters:

name - the filename to decode

escape - the escape character to use

Returns:

the original name

findRelativePath

public static String findRelativePath(String base,
                                      String path)
                               throws IOException

Build a relative path to the given base path.

Parameters:

base - - the path used as the base

path - - the path to compute relative to the base path

Returns:

A relative path from base to path

Throws:

IOException