de.unkrig.commons.io.pipe

Class PipeUtil

java.lang.Object

de.unkrig.commons.io.pipe.PipeUtil

public final class PipeUtil
extends java.lang.Object

Utility methods related to the Pipe interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PipeUtil.Drainer Drains 'something' by reading data from an input stream.
static interface	PipeUtil.Filler Fills 'something' by writing data to an output stream.
static interface	PipeUtil.FillerAndDrainer
static interface	PipeUtil.InputOutputStreams A tuple of one InputStream and one OutputStream.

Method Summary

Modifier and Type	Method and Description
static PipeUtil.InputOutputStreams	asInputOutputStreams(Pipe pipe) Creates and returns a pair of output stream and input stream which write to and read from the given pipe.
static PipeUtil.InputOutputStreams	asInputOutputStreams(Pipe pipe, boolean blocking) Creates and returns a pair of output stream and input stream which write to and read from the given pipe.
static Pipe	deleteFileOnClose(Pipe delegate, java.io.File file)
static Pipe	onClose(Pipe delegate, RunnableWhichThrows<java.io.IOException> runnable)
static void	temporaryStorage(PipeUtil.FillerAndDrainer fillerAndDrainer) Convenience method for temporaryStorage(Filler, Drainer) when the filler wants to pass information to the drainer.
static void	temporaryStorage(PipeUtil.Filler filler, PipeUtil.Drainer drainer) Creates a temporary PipeFactory.elasticPipe(), invokes the filler (which fills the pipe), then invokes the drainer (which drains the pipe), and eventually closes the pipe.

Methods inherited from class java.lang.Object

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

Method Detail

asInputOutputStreams

public static PipeUtil.InputOutputStreams asInputOutputStreams(Pipe pipe)

Creates and returns a pair of output stream and input stream which write to and read from the given pipe. The streams block the calling thread while the pipe is full resp. empty.

This method is equivalent with

   asInputOutputStream(pipe, true);
 

asInputOutputStreams

public static PipeUtil.InputOutputStreams asInputOutputStreams(Pipe pipe,
                                                               boolean blocking)

Creates and returns a pair of output stream and input stream which write to and read from the given pipe.

While the pipe is full: If blocking== true then the output stream blocks until space is available. Otherwise, if blocking== false, the output stream throws a BlockingException.

While the pipe is empty: If blocking== true then the input stream blocks until data is available, otherwise, if blocking== false, the input stream throws a BlockingException.

Closing the output stream indicates an end-of-input condition to the input stream.

Closing the input stream closes the pipe, and the next write attempt to the output stream will cause an EOFException.

deleteFileOnClose

public static Pipe deleteFileOnClose(Pipe delegate,
                                     java.io.File file)

Returns:

A pipe which forwards all operations to the delegate, and, in addition, deletes the file when the pipe is closed

onClose

public static Pipe onClose(Pipe delegate,
                           RunnableWhichThrows<java.io.IOException> runnable)

Returns:

A pipe which forwards all operations to the given delegate, and, in addition, runs the given runnable on Pipe.close() AFTER having closed the delegate

temporaryStorage

public static void temporaryStorage(PipeUtil.FillerAndDrainer fillerAndDrainer)
                             throws java.io.IOException

Convenience method for temporaryStorage(Filler, Drainer) when the filler wants to pass information to the drainer.

Throws:

java.io.IOException

temporaryStorage

public static void temporaryStorage(PipeUtil.Filler filler,
                                    PipeUtil.Drainer drainer)
                             throws java.io.IOException

Creates a temporary PipeFactory.elasticPipe(), invokes the filler (which fills the pipe), then invokes the drainer (which drains the pipe), and eventually closes the pipe.

Throws:

java.io.IOException