org.shared.util

Class IoBase

java.lang.Object

org.shared.util.IoBase

public class IoBase
extends Object

A static utility class for I/O operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BULK_TRANSFER_SIZE The bulk transfer size for InputStreams and OutputStreams.
protected static ThreadLocal<Map<String,String>>	environmentLocal A mapping of environment variables local to the current thread in support of beginEnvironment() and endEnvironment().
static InputStream	nullInputStream A null InputStream that has nothing to read.
static OutputStream	nullOutputStream A null OutputStream to which writes have no effect.

Method Summary

Methods

Modifier and Type	Method and Description
static Map<String,String>	beginEnvironment() Begins building the mapping of environment variables for Thread.currentThread().
static void	close(Closeable closeable) A Closeable.close() convenience wrapper.
static boolean	copy(File src, File dst) Copies a file or directory.
static boolean	delete(File f) Deletes a file or directory.
static void	endEnvironment() Ends building the mapping of environment variables for Thread.currentThread().
static int	execAndWaitFor(InputStream parentIn, OutputStream parentOut, OutputStream parentError, File workingDir, String... execArgs) Forks and waits on a new Process.
static int	execAndWaitFor(InputStream parentIn, OutputStream parentOut, String... execArgs) Forks and waits on a new Process.
static int	execAndWaitFor(InputStream parentIn, String... execArgs) Forks and waits on a new Process.
static int	execAndWaitFor(OutputStream parentOut, String... execArgs) Forks and waits on a new Process.
static int	execAndWaitFor(String... execArgs) Forks and waits on a new Process.
static byte[]	getBytes(File inFile) Gets a byte array from the given file.
static byte[]	getBytes(InputStream in) Gets a byte array from the given stream.
static boolean	isSymbolicLink(File f) Gets whether the given file is a symbolic link.
static void	transfer(byte[] bytes, File outFile) Transfers the contents of a byte array into a file without appending.
static void	transfer(byte[] bytes, File outFile, boolean append) Transfers the contents of a byte array into a file.
static void	transfer(byte[] bytes, OutputStream out) Transfers the contents of a byte array into a stream.
static void	transfer(File inFile, File outFile) Transfers the contents of a file into a file without appending.
static void	transfer(File inFile, File outFile, boolean append) Transfers the contents of a file into a file.
static void	transfer(File inFile, OutputStream out) Transfers the contents of a file into a stream.
static void	transfer(InputStream in, File outFile) Transfers the contents of a stream into a file without appending.
static void	transfer(InputStream in, File outFile, boolean append) Transfers the contents of a stream into a file.
static void	transfer(InputStream in, OutputStream out) Transfers the contents of one stream into another.

Methods inherited from class java.lang.Object

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

Field Detail

BULK_TRANSFER_SIZE

protected static final int BULK_TRANSFER_SIZE

The bulk transfer size for InputStreams and OutputStreams.

See Also:

Constant Field Values

nullOutputStream

public static final OutputStream nullOutputStream

A null OutputStream to which writes have no effect.

nullInputStream

public static final InputStream nullInputStream

A null InputStream that has nothing to read.

environmentLocal

protected static final ThreadLocal<Map<String,String>> environmentLocal

A mapping of environment variables local to the current thread in support of beginEnvironment() and endEnvironment().

Method Detail

close

public static final void close(Closeable closeable)

A Closeable.close() convenience wrapper.

delete

public static final boolean delete(File f)

Deletes a file or directory. If a directory, then recursively deletes the contents while not following symbolic links.

Parameters:

f - the file or directory.

Returns:

true if and only if the file or directory was deleted.

copy

public static final boolean copy(File src,
           File dst)

Copies a file or directory. If a directory, then recursively copies the contents while not following symbolic links.

Parameters:

src - the source file or directory.

dst - the destination file or directory.

Returns:

true if and only if the copy operation went smoothly.

isSymbolicLink

public static final boolean isSymbolicLink(File f)

Gets whether the given file is a symbolic link.

transfer

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

Transfers the contents of one stream into another.

Parameters:

in - the InputStream.

out - the OutputStream.

Throws:

IOException - when something goes awry.

transfer

public static final void transfer(File inFile,
            OutputStream out)
                           throws IOException

Transfers the contents of a file into a stream.

Parameters:

inFile - the input File.

out - the OutputStream.

Throws:

IOException - when something goes awry.

transfer

public static final void transfer(InputStream in,
            File outFile,
            boolean append)
                           throws IOException

Transfers the contents of a stream into a file.

Parameters:

in - the InputStream.

outFile - the output File.

append - whether this operation overwrites the file, or merely appends onto the end.

Throws:

IOException - when something goes awry.

transfer

public static final void transfer(File inFile,
            File outFile,
            boolean append)
                           throws IOException

Transfers the contents of a file into a file.

Parameters:

inFile - the input File.

outFile - the output File.

append - whether this operation overwrites the file, or merely appends onto the end.

Throws:

IOException - when something goes awry.

transfer

public static final void transfer(InputStream in,
            File outFile)
                           throws IOException

Transfers the contents of a stream into a file without appending.

Parameters:

in - the InputStream.

outFile - the output File.

Throws:

IOException - when something goes awry.

transfer

public static final void transfer(File inFile,
            File outFile)
                           throws IOException

Transfers the contents of a file into a file without appending.

Parameters:

inFile - the input File.

outFile - the output File.

Throws:

IOException - when something goes awry.

transfer

public static final void transfer(byte[] bytes,
            OutputStream out)
                           throws IOException

Transfers the contents of a byte array into a stream.

Parameters:

bytes - the byte array.

out - the OutputStream.

Throws:

IOException - when something goes awry.

transfer

public static final void transfer(byte[] bytes,
            File outFile,
            boolean append)
                           throws IOException

Transfers the contents of a byte array into a file.

Parameters:

bytes - the byte array.

outFile - the output File.

append - whether this operation overwrites the file, or merely appends onto the end.

Throws:

IOException - when something goes awry.

transfer

public static final void transfer(byte[] bytes,
            File outFile)
                           throws IOException

Transfers the contents of a byte array into a file without appending.

Parameters:

bytes - the byte array.

outFile - the output File.

Throws:

IOException - when something goes awry.

getBytes

public static final byte[] getBytes(InputStream in)
                             throws IOException

Gets a byte array from the given stream.

Parameters:

in - the InputStream.

Returns:

the byte array.

Throws:

IOException - when something goes awry.

getBytes

public static final byte[] getBytes(File inFile)
                             throws IOException

Gets a byte array from the given file.

Parameters:

inFile - the input File.

Returns:

the byte array.

Throws:

IOException - when something goes awry.

execAndWaitFor

public static final int execAndWaitFor(InputStream parentIn,
                 OutputStream parentOut,
                 OutputStream parentError,
                 File workingDir,
                 String... execArgs)
                                throws IOException

Forks and waits on a new Process.

Parameters:

parentIn - the InputStream that contains the child's input.

parentOut - the OutputStream that receives the child's output.

parentError - the OutputStream that receives the child's error output.

workingDir - the working directory.

execArgs - the command and arguments to execute.

Returns:

the return code of the child process.

Throws:

IOException - when something goes awry.

execAndWaitFor

public static final int execAndWaitFor(String... execArgs)
                                throws IOException

Forks and waits on a new Process.

Parameters:

execArgs - the command and arguments to execute.

Returns:

the return code of the child process.

Throws:

IOException - when something goes awry.

execAndWaitFor

public static final int execAndWaitFor(InputStream parentIn,
                 String... execArgs)
                                throws IOException

Forks and waits on a new Process.

Parameters:

parentIn - the InputStream that contains the child's input.

execArgs - the command and arguments to execute.

Returns:

the return code of the child process.

Throws:

IOException - when something goes awry.

execAndWaitFor

public static final int execAndWaitFor(OutputStream parentOut,
                 String... execArgs)
                                throws IOException

Forks and waits on a new Process.

Parameters:

parentOut - the OutputStream that receives the child's output.

execArgs - the command and arguments to execute.

Returns:

the return code of the child process.

Throws:

IOException - when something goes awry.

execAndWaitFor

public static final int execAndWaitFor(InputStream parentIn,
                 OutputStream parentOut,
                 String... execArgs)
                                throws IOException

Forks and waits on a new Process.

Parameters:

parentIn - the InputStream that contains the child's input.

parentOut - the OutputStream that receives the child's output.

execArgs - the command and arguments to execute.

Returns:

the return code of the child process.

Throws:

IOException - when something goes awry.

beginEnvironment

public static final Map<String,String> beginEnvironment()

Begins building the mapping of environment variables for Thread.currentThread().

endEnvironment

public static final void endEnvironment()

Ends building the mapping of environment variables for Thread.currentThread().