org.archive.util

Class FileUtils

java.lang.Object

org.archive.util.FileUtils

public class FileUtils
extends java.lang.Object

Utility methods for manipulating files and directories.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.LinkedList<java.io.File>	pendingDeletes

Method Summary

Modifier and Type	Method and Description
static void	appendTo(java.io.File fileToAppendTo, java.io.File fileToAppendFrom)
static java.io.File	assertReadable(java.io.File f) Test file exists and is readable.
static boolean	copyFile(java.io.File src, java.io.File dest) Copy the src file to the destination.
static boolean	copyFile(java.io.File src, java.io.File dest, long extent) Copy up to extent bytes of the source file to the destination.
static boolean	copyFile(java.io.File src, java.io.File dest, long extent, boolean overwrite) Copy up to extent bytes of the source file to the destination
static void	deleteSoonerOrLater(java.io.File fileToDelete) Delete the file now -- but in the event of failure, keep trying in the future.
static java.io.File	ensureWriteableDirectory(java.io.File dir) Ensure writeable directory.
static java.util.List<java.io.File>	ensureWriteableDirectory(java.util.List<java.io.File> dirs) Ensure writeable directories.
static java.io.File	ensureWriteableDirectory(java.lang.String dir) Ensure writeable directory.
static org.apache.commons.lang.math.LongRange	expandRange(org.apache.commons.lang.math.LongRange range1, org.apache.commons.lang.math.LongRange range2)
static java.io.File[]	getFilesWithPrefix(java.io.File dir, java.lang.String prefix) Get a list of all files in directory that have passed prefix.
static org.apache.commons.io.filefilter.IOFileFilter	getRegexFileFilter(java.lang.String regex) Get a @link java.io.FileFilter that filters files based on a regular expression.
static boolean	isReadableWithExtensionAndMagic(java.io.File f, java.lang.String uncompressedExtension, java.lang.String magic)
static java.util.Properties	loadProperties(java.io.File file) Load Properties instance from a File
static java.io.File	maybeRelative(java.io.File context, java.lang.String path) Turn path into a File, relative to context (which may be ignored if path is absolute).
static boolean	moveAsideIfExists(java.io.File file)
static org.apache.commons.lang.math.LongRange	pagedLines(java.io.File file, long position, int signedDesiredLongCount, java.util.List<java.lang.String> lines)
static org.apache.commons.lang.math.LongRange	pagedLines(java.io.File file, long position, int signedDesiredLineCount, java.util.List<java.lang.String> lines, int lineEstimate) Retrieve a number of lines from the file around the given position, as when paging forward or backward through a file.
static long	readFullyToFile(java.io.InputStream is, java.io.File toFile) Read the entire stream to EOF into the passed file.
static void	storeProperties(java.util.Properties p, java.io.File file) Store Properties instance to a File
static java.io.File	tryToCanonicalize(java.io.File file)
protected static void	workaroundCopyFile(java.io.File src, java.io.File dest)

Methods inherited from class java.lang.Object

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

Field Detail

pendingDeletes

protected static java.util.LinkedList<java.io.File> pendingDeletes

Method Detail

copyFile

public static boolean copyFile(java.io.File src,
                               java.io.File dest)
                        throws java.io.FileNotFoundException,
                               java.io.IOException

Copy the src file to the destination. Deletes any preexisting file at destination.

Parameters:

src -

dest -

Returns:

True if the extent was greater than actual bytes copied.

Throws:

java.io.FileNotFoundException

java.io.IOException

copyFile

public static boolean copyFile(java.io.File src,
                               java.io.File dest,
                               long extent)
                        throws java.io.FileNotFoundException,
                               java.io.IOException

Copy up to extent bytes of the source file to the destination. Deletes any preexisting file at destination.

Parameters:

src -

dest -

extent - Maximum number of bytes to copy

Returns:

True if the extent was greater than actual bytes copied.

Throws:

java.io.FileNotFoundException

java.io.IOException

copyFile

public static boolean copyFile(java.io.File src,
                               java.io.File dest,
                               long extent,
                               boolean overwrite)
                        throws java.io.FileNotFoundException,
                               java.io.IOException

Copy up to extent bytes of the source file to the destination

Parameters:

src -

dest -

extent - Maximum number of bytes to copy

overwrite - If target file already exits, and this parameter is true, overwrite target file (We do this by first deleting the target file before we begin the copy).

Returns:

True if the extent was greater than actual bytes copied.

Throws:

java.io.FileNotFoundException

java.io.IOException

workaroundCopyFile

protected static void workaroundCopyFile(java.io.File src,
                                         java.io.File dest)
                                  throws java.io.IOException

Throws:

java.io.IOException

getFilesWithPrefix

public static java.io.File[] getFilesWithPrefix(java.io.File dir,
                                                java.lang.String prefix)

Get a list of all files in directory that have passed prefix.

Parameters:

dir - Dir to look in.

prefix - Basename of files to look for. Compare is case insensitive.

Returns:

List of files in dir that start w/ passed basename.

getRegexFileFilter

public static org.apache.commons.io.filefilter.IOFileFilter getRegexFileFilter(java.lang.String regex)

Get a @link java.io.FileFilter that filters files based on a regular expression.

Parameters:

regex - the regular expression the files must match.

Returns:

the newly created filter.

assertReadable

public static java.io.File assertReadable(java.io.File f)
                                   throws java.io.FileNotFoundException

Test file exists and is readable.

Parameters:

f - File to test.

Throws:

java.io.FileNotFoundException - If file does not exist or is not unreadable.

isReadableWithExtensionAndMagic

public static boolean isReadableWithExtensionAndMagic(java.io.File f,
                                                      java.lang.String uncompressedExtension,
                                                      java.lang.String magic)
                                               throws java.io.IOException

Parameters:

f - File to test.

Returns:

True if file is readable, has uncompressed extension, and magic string at file start.

Throws:

java.io.IOException - If file not readable or other problem.

maybeRelative

public static java.io.File maybeRelative(java.io.File context,
                                         java.lang.String path)

Turn path into a File, relative to context (which may be ignored if path is absolute).

Parameters:

context - File context if path is relative

path - String path to make into a File

Returns:

File created

loadProperties

public static java.util.Properties loadProperties(java.io.File file)
                                           throws java.io.IOException

Load Properties instance from a File

Parameters:

file -

Returns:

Properties

Throws:

java.io.IOException

storeProperties

public static void storeProperties(java.util.Properties p,
                                   java.io.File file)
                            throws java.io.IOException

Store Properties instance to a File

Parameters:

p -

file - destination File

Throws:

java.io.IOException

moveAsideIfExists

public static boolean moveAsideIfExists(java.io.File file)
                                 throws java.io.IOException

Throws:

java.io.IOException

pagedLines

public static org.apache.commons.lang.math.LongRange pagedLines(java.io.File file,
                                                                long position,
                                                                int signedDesiredLineCount,
                                                                java.util.List<java.lang.String> lines,
                                                                int lineEstimate)
                                                         throws java.io.IOException

Retrieve a number of lines from the file around the given position, as when paging forward or backward through a file.

Parameters:

file - File to retrieve lines

position - offset to anchor lines

signedDesiredLineCount - lines requested; if negative, want this number of lines ending with a line containing the position; if positive, want this number of lines, all starting at or after position.

lines - List to insert found lines

lineEstimate - int estimate of line size, 0 means use default of 128

Returns:

LongRange indicating the file offsets corresponding to the beginning of the first line returned, and the point after the end of the last line returned

Throws:

java.io.IOException

expandRange

public static org.apache.commons.lang.math.LongRange expandRange(org.apache.commons.lang.math.LongRange range1,
                                                                 org.apache.commons.lang.math.LongRange range2)

pagedLines

public static org.apache.commons.lang.math.LongRange pagedLines(java.io.File file,
                                                                long position,
                                                                int signedDesiredLongCount,
                                                                java.util.List<java.lang.String> lines)
                                                         throws java.io.IOException

Throws:

java.io.IOException

deleteSoonerOrLater

public static void deleteSoonerOrLater(java.io.File fileToDelete)

Delete the file now -- but in the event of failure, keep trying in the future. VERY IMPORTANT: Do not use with any file whose name/path may be reused, because the lagged delete could then wind up deleting the newer file. Essentially, only to be used with uniquely-named temp files. Necessary because some platforms (looking at you, JVM-on-Windows) will have deletes fail because of things like file-mapped buffers remaining, and there's no explicit way to unmap a buffer. (See 6-year-old Sun-stumping Java bug http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4724038 ) We just have to wait and retry. (Why not just File.deleteOnExit? There could be an arbitrary, unbounded number of files in such a situation, that are only deletable a few seconds or minutes after our first attempt. Waiting for JVM exist could mean disk exhaustion. It's also unclear if the native FS class implementations of deleteOnExit use RAM per pending file.)

Parameters:

fileToDelete -

readFullyToFile

public static long readFullyToFile(java.io.InputStream is,
                                   java.io.File toFile)
                            throws java.io.IOException

Read the entire stream to EOF into the passed file. Closes is when done or if an exception.

Parameters:

is - Stream to read.

toFile - File to write to.

Throws:

java.io.IOException

ensureWriteableDirectory

public static java.io.File ensureWriteableDirectory(java.lang.String dir)
                                             throws java.io.IOException

Ensure writeable directory. If doesn't exist, we attempt creation.

Parameters:

dir - Directory to test for exitence and is writeable.

Returns:

The passed dir.

Throws:

java.io.IOException - If passed directory does not exist and is not createable, or directory is not writeable or is not a directory.

ensureWriteableDirectory

public static java.util.List<java.io.File> ensureWriteableDirectory(java.util.List<java.io.File> dirs)
                                                             throws java.io.IOException

Ensure writeable directories. If doesn't exist, we attempt creation.

Parameters:

dirs - List of Files to test.

Returns:

The passed dirs.

Throws:

java.io.IOException - If passed directory does not exist and is not createable, or directory is not writeable or is not a directory.

ensureWriteableDirectory

public static java.io.File ensureWriteableDirectory(java.io.File dir)
                                             throws java.io.IOException

Ensure writeable directory. If doesn't exist, we attempt creation.

Parameters:

dir - Directory to test for exitence and is writeable.

Returns:

The passed dir.

Throws:

java.io.IOException - If passed directory does not exist and is not createable, or directory is not writeable or is not a directory.

tryToCanonicalize

public static java.io.File tryToCanonicalize(java.io.File file)

appendTo

public static void appendTo(java.io.File fileToAppendTo,
                            java.io.File fileToAppendFrom)
                     throws java.io.IOException

Throws:

java.io.IOException