org.waarp.common.file

Class FileUtils

java.lang.Object

org.waarp.common.file.FileUtils

public final class FileUtils
extends Object

File Utils

Field Summary

Fields

Modifier and Type	Field and Description
static int	ZERO_COPY_CHUNK_SIZE

Method Summary

Modifier and Type	Method and Description
static void	close(InputStream stream)
static void	close(OutputStream stream)
static void	close(RandomAccessFile accessFile)
static void	close(Reader stream)
static void	close(Writer stream)
static void	computeGlobalHash(FilesystemBasedDigest digest, File file, int length) Compute global hash (if possible) from a file but up to length
static File[]	copy(File[] from, File directoryTo, boolean move) Copy a group of files to a directory (will ignore directories)
static void	copy(File from, File to, boolean move, boolean append) Copy one file to another one
static long	copy(InputStream from, OutputStream to) From Google Guava copy within ByteStreams Copies all bytes from the input stream to the output stream.
static void	copy(int blockSize, InputStream inputStream, OutputStream out) Helper method to write from InputStream to OutputStream, closing streams
static File[]	copyRecursive(File from, File directoryTo, boolean move) Copy from a directory to a directory with recursivity
static boolean	createDir(File directory) Create the directory associated with the File as path
static boolean	delete(File file) Delete physically the file
static boolean	deleteDir(File directory) Delete the directory associated with the File as path if empty
static boolean	deleteRecursiveDir(File directory) Delete the directory and its subdirs associated with the File as path if empty
static boolean	fileExist(String fileName, String path)
static boolean	forceDeleteRecursiveDir(File directory) Delete all its subdirs and files associated, not itself
static File[]	getFiles(File directory) Get the list of files from a given directory
static File[]	getFiles(File directory, FilenameFilter filter) Get the list of files from a given directory and a filter
static boolean	isInSubdirectory(File dir, File file) Check if the file (directory or file) is in directory dir or in sub directories of dir
static long	uncompressedBz2File(File fileIn, File fileOut) Read one compressed file and return the associated BufferedReader

Methods inherited from class java.lang.Object

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

Field Detail

ZERO_COPY_CHUNK_SIZE

public static final int ZERO_COPY_CHUNK_SIZE

See Also:

Constant Field Values

Method Detail

close

public static void close(Reader stream)

close

public static void close(Writer stream)

close

public static void close(InputStream stream)

close

public static void close(OutputStream stream)

close

public static void close(RandomAccessFile accessFile)

deleteDir

public static boolean deleteDir(File directory)

Delete the directory associated with the File as path if empty

Parameters:

directory -

Returns:

True if deleted, False else.

delete

public static boolean delete(File file)

Delete physically the file

Parameters:

file -

Returns:

True if OK, else if not (or if the file never exists).

copyRecursive

public static File[] copyRecursive(File from,
                                   File directoryTo,
                                   boolean move)
                            throws Reply550Exception

Copy from a directory to a directory with recursivity

Parameters:

from -

directoryTo -

move - True if the copy is in fact a move operation

Returns:

the group of copy files or null (partially or totally) if an error occurs

Throws:

Reply550Exception

copy

public static File[] copy(File[] from,
                          File directoryTo,
                          boolean move)
                   throws Reply550Exception

Copy a group of files to a directory (will ignore directories)

Parameters:

from -

directoryTo -

move - True if the copy is in fact a move operation

Returns:

the group of copy files or null (partially or totally) if an error occurs

Throws:

Reply550Exception

createDir

public static boolean createDir(File directory)

Create the directory associated with the File as path

Parameters:

directory -

Returns:

True if created, False else.

copy

public static void copy(File from,
                        File to,
                        boolean move,
                        boolean append)
                 throws Reply550Exception

Copy one file to another one

Parameters:

from -

to -

move - True if the copy is in fact a move operation

append - True if the copy is in append

Throws:

Reply550Exception

forceDeleteRecursiveDir

public static boolean forceDeleteRecursiveDir(File directory)

Delete all its subdirs and files associated, not itself

Parameters:

directory -

Returns:

True if all sub directories or files are deleted, False else.

deleteRecursiveDir

public static boolean deleteRecursiveDir(File directory)

Delete the directory and its subdirs associated with the File as path if empty

Parameters:

directory -

Returns:

True if deleted, False else.

fileExist

public static boolean fileExist(String fileName,
                                String path)

Parameters:

fileName -

path -

Returns:

true if the file exist in the specified path

getFiles

public static File[] getFiles(File directory)

Get the list of files from a given directory

Parameters:

directory -

Returns:

the list of files (as an array)

computeGlobalHash

public static void computeGlobalHash(FilesystemBasedDigest digest,
                                     File file,
                                     int length)

Compute global hash (if possible) from a file but up to length

Parameters:

digest -

file -

length -

getFiles

public static File[] getFiles(File directory,
                              FilenameFilter filter)

Get the list of files from a given directory and a filter

Parameters:

directory -

filter -

Returns:

the list of files (as an array)

uncompressedBz2File

public static long uncompressedBz2File(File fileIn,
                                       File fileOut)

Read one compressed file and return the associated BufferedReader

Parameters:

fileIn -

fileOut -

Returns:

the size of the uncompressed file or -1 if an error occurs

copy

public static long copy(InputStream from,
                        OutputStream to)
                 throws IOException

From Google Guava copy within ByteStreams Copies all bytes from the input stream to the output stream. Does not close or flush either stream.

Parameters:

from - the input stream to read from

to - the output stream to write to

Returns:

the number of bytes copied

Throws:

IOException - if an I/O error occurs

copy

public static void copy(int blockSize,
                        InputStream inputStream,
                        OutputStream out)
                 throws IOException

Helper method to write from InputStream to OutputStream, closing streams

Parameters:

blockSize -

inputStream -

out -

Throws:

IOException

isInSubdirectory

public static boolean isInSubdirectory(File dir,
                                       File file)

Check if the file (directory or file) is in directory dir or in sub directories of dir

Parameters:

dir -

file -

Returns:

True if in (sub) directory (of) dir