com.github.robtimus.io.stream

Class TextPipe

java.lang.Object

com.github.robtimus.io.stream.TextPipe

public final class TextPipe
extends Object

An in-memory pipe. It can be used to connect code expecting a reader with code expecting a writer.

This is a port of Go's io.Pipe. Like io.Pipe, each write to a PipedWriter blocks until all of its data has been consumed, either through reads or skips. Data is copied directly from the writer to the reader without any internal buffering.

Because reads and writes both block, writing to and reading from the pipe should not be done from the same thread. Attempting to do so will introduce deadlocks.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor and Description
TextPipe() Creates a new text pipe.

Method Summary

Modifier and Type	Method and Description
boolean	closed() Returns whether or not the pipe is closed.
PipeReader	input() Returns the pipe's reader.
PipeWriter	output() Returns the pipe's writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextPipe

public TextPipe()

Creates a new text pipe.

Method Detail

input

public PipeReader input()

Returns the pipe's reader.

Returns:

The pipe's reader.

output

public PipeWriter output()

Returns the pipe's writer.

Returns:

The pipe's writer.

closed

public boolean closed()

Returns whether or not the pipe is closed. The pipe can be closed by either closing the input or the output.

Returns:

true if the pipe is closed, or false otherwise.