Package org.dellroad.stuff.io

Class PipedStreams

java.lang.Object

org.dellroad.stuff.io.PipedStreams

public class PipedStreams
extends Object

A better piped input/output stream pair.

The two ends of the pipe are returned by getInputStream() and getOutputStream(). Both streams are fully thread safe. The aliveness of any particular thread that happens to be the last writer to the output stream is irrelevant.

See Also:

• JDK-4028322

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipedStreams.HasPipedStreams	Interface implemented by the InputStream and OutputStream associated with a PipedStreams instance.
final class	PipedStreams.Input	The InputStream associated with a PipedStreams instance.
final class	PipedStreams.Output	The OutputStream associated with a PipedStreams instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_BUFFER_SIZE	Default internal buffer size (8160).

Constructor Summary

Constructors

Constructor	Description
PipedStreams()	Constructor.
PipedStreams(int bufsiz)	Constructor.

Method Summary

Modifier and Type	Method	Description
PipedStreams.Input	getInputStream()	Get the input side of the pipe.
PipedStreams.Output	getOutputStream()	Get the output side of the pipe.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

Default internal buffer size (8160).

See Also:

• Constant Field Values

Constructor Details

PipedStreams

public PipedStreams()

Constructor.

PipedStreams

public PipedStreams(int bufsiz)

Constructor.

Parameters:

bufsiz - internal buffer size

Throws:

IllegalArgumentException - if bufsiz is zero or negative

Method Details

getInputStream

public PipedStreams.Input getInputStream()

Get the input side of the pipe.

Regarding the returned InputStream:

• When the internal buffer is empty, reads block until more data is written to the output side, or the output side is closed.
• If the current thread is interrupted while blocked, an InterruptedIOException is thrown.

Returns:

input side of the piped stream

getOutputStream

public PipedStreams.Output getOutputStream()

Get the output side of the pipe.

Regarding the returned OutputStream:

• When the internal buffer is full, writes block until more data is read from the input side.
• If the current thread is interrupted while blocked, an InterruptedIOException is thrown.
• After the input side side is closed, trying to write more data will generate an IOException.

Returns:

output side of the piped stream