org.apache.maven.mercury.util
Class FileUtil

java.lang.Object
  org.apache.maven.mercury.util.FileUtil

public class FileUtil
extends java.lang.Object

File related utilities: copy, write, sign, verify, etc.

Version:

$Id: FileUtil.java 720564 2008-11-25 18:58:02Z ogusakov $

Author:

Oleg Gusakov

Field Summary

static java.lang.String	DASH
static char	DASH_CHAR
static int	DEFAULT_BUFFER_SIZE
static java.lang.String	DEFAULT_CHARSET
static int	K
static java.lang.String	LOCK_FILE
static java.lang.String	SEP
static char	SEP_CHAR

Constructor Summary

FileUtil()

Method Summary

static void	copy(java.io.File fromFile, java.io.File toFile, boolean clean)
static void	delete(java.io.File f)
static int	depth(java.io.File file)
java.util.List<java.lang.String>	dirToList(java.io.File dir, boolean includeDirs, boolean includeFiles)
static FileLockBundle	lockDir(java.lang.String dir, long millis, long sleepFor) try to acquire lock on specified directory for millis milliseconds
static FileLockBundle	lockDirNio(java.lang.String dir, long millis, long sleepFor) try to acquire lock on specified directory for millis milliseconds
static void	main(java.lang.String[] args)
static java.util.Set<StreamObserverFactory>	oSet(StreamObserverFactory... facs)
static byte[]	readRawData(java.io.File file)
static byte[]	readRawData(java.io.File file, java.util.Collection<StreamVerifierFactory> vFacs)
static byte[]	readRawData(java.io.InputStream in)
static java.lang.String	readRawDataAsString(java.io.File file) Read the content of a file and converts it with UTF-8 encoding to a String.
static void	renameFile(java.io.File dir, java.lang.String from, java.lang.String to)
static void	sign(java.io.File f, java.util.Set<StreamVerifierFactory> vFacs, boolean recurse, boolean force)
static void	unlockDir(java.lang.String dir)
static void	verify(java.io.File f, java.util.Set<StreamVerifierFactory> vFacs, boolean recurse, boolean force)
static java.util.Set<StreamVerifierFactory>	vSet(StreamVerifierFactory... facs)
static void	writeAndSign(java.lang.String fName, byte[] bytes, java.util.Set<StreamVerifierFactory> vFacs)
static void	writeAndSign(java.lang.String fName, java.io.InputStream in, java.util.Set<StreamVerifierFactory> vFacs)
static void	writeRawData(java.io.File file, byte[] bytes)
static void	writeRawData(java.io.File f, java.io.InputStream in)
static void	writeRawData(java.io.File file, java.lang.String sBytes) Write UTF-8 representation of a String to a File.

Methods inherited from class java.lang.Object

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

Field Detail

SEP

public static final java.lang.String SEP

See Also:

Constant Field Values

SEP_CHAR

public static final char SEP_CHAR

DASH

public static final java.lang.String DASH

See Also:

Constant Field Values

DASH_CHAR

public static final char DASH_CHAR

LOCK_FILE

public static final java.lang.String LOCK_FILE

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final java.lang.String DEFAULT_CHARSET

See Also:

Constant Field Values

K

public static final int K

See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

FileUtil

public FileUtil()

Method Detail

delete

public static void delete(java.io.File f)

copy

public static void copy(java.io.File fromFile,
                        java.io.File toFile,
                        boolean clean)
                 throws java.io.IOException

Throws:

java.io.IOException

readRawDataAsString

public static java.lang.String readRawDataAsString(java.io.File file)
                                            throws java.io.IOException

Read the content of a file and converts it with UTF-8 encoding to a String.

Throws:

java.io.IOException

readRawData

public static byte[] readRawData(java.io.File file)
                          throws java.io.IOException

Throws:

java.io.IOException

readRawData

public static byte[] readRawData(java.io.File file,
                                 java.util.Collection<StreamVerifierFactory> vFacs)
                          throws java.io.IOException,
                                 FileUtilException,
                                 StreamVerifierException

Throws:

java.io.IOException

FileUtilException

StreamVerifierException

readRawData

public static byte[] readRawData(java.io.InputStream in)
                          throws java.io.IOException

Throws:

java.io.IOException

writeRawData

public static void writeRawData(java.io.File file,
                                java.lang.String sBytes)
                         throws java.io.IOException

Write UTF-8 representation of a String to a File.

Throws:

java.io.IOException

writeRawData

public static void writeRawData(java.io.File f,
                                java.io.InputStream in)
                         throws java.io.IOException

Throws:

java.io.IOException

writeRawData

public static void writeRawData(java.io.File file,
                                byte[] bytes)
                         throws java.io.IOException

Throws:

java.io.IOException

writeAndSign

public static void writeAndSign(java.lang.String fName,
                                byte[] bytes,
                                java.util.Set<StreamVerifierFactory> vFacs)
                         throws java.io.IOException,
                                StreamObserverException

Throws:

java.io.IOException

StreamObserverException

writeAndSign

public static void writeAndSign(java.lang.String fName,
                                java.io.InputStream in,
                                java.util.Set<StreamVerifierFactory> vFacs)
                         throws java.io.IOException,
                                StreamObserverException

Throws:

java.io.IOException

StreamObserverException

dirToList

public java.util.List<java.lang.String> dirToList(java.io.File dir,
                                                  boolean includeDirs,
                                                  boolean includeFiles)

sign

public static void sign(java.io.File f,
                        java.util.Set<StreamVerifierFactory> vFacs,
                        boolean recurse,
                        boolean force)
                 throws java.io.IOException,
                        StreamObserverException

Parameters:

f -

vFacs -

recurse -

force -

Throws:

java.io.IOException

StreamObserverException

verify

public static void verify(java.io.File f,
                          java.util.Set<StreamVerifierFactory> vFacs,
                          boolean recurse,
                          boolean force)
                   throws java.io.IOException,
                          StreamObserverException

Throws:

java.io.IOException

StreamObserverException

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        StreamObserverException

Throws:

java.io.IOException

StreamObserverException

lockDir

public static FileLockBundle lockDir(java.lang.String dir,
                                     long millis,
                                     long sleepFor)
                              throws java.io.IOException

try to acquire lock on specified directory for millis milliseconds

Parameters:

dir - directory to lock

millis - how long to wait for the lock before surrendering

sleepFor - how long to sleep between attempts

Returns:

obtained FileLock or null

Throws:

java.io.IOException - if there were problems obtaining the lock

lockDirNio

public static FileLockBundle lockDirNio(java.lang.String dir,
                                        long millis,
                                        long sleepFor)
                                 throws java.io.IOException

try to acquire lock on specified directory for millis milliseconds

Parameters:

dir - directory to lock

millis - how long to wait for the lock before surrendering

sleepFor - how long to sleep between attempts

Returns:

obtained FileLock or null

Throws:

java.io.IOException - if there were problems obtaining the lock

unlockDir

public static void unlockDir(java.lang.String dir)

vSet

public static final java.util.Set<StreamVerifierFactory> vSet(StreamVerifierFactory... facs)

oSet

public static final java.util.Set<StreamObserverFactory> oSet(StreamObserverFactory... facs)

renameFile

public static void renameFile(java.io.File dir,
                              java.lang.String from,
                              java.lang.String to)

depth

public static int depth(java.io.File file)