com.github.robtimus.io.stream

Class PipeOutputStream

java.lang.Object

java.io.OutputStream

com.github.robtimus.io.stream.PipeOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class PipeOutputStream
extends OutputStream

An input stream that writes to a BinaryPipe.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
void	close() Closes this output stream.
void	close(IOException error) Closes this output stream.
void	flush()
BinaryPipe	pipe() Returns the pipe that this output stream is writing to.
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Method Detail

pipe

public BinaryPipe pipe()

Returns the pipe that this output stream is writing to.

Returns:

The pipe that this output stream is writing to.

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()

Closes this output stream. After calling this method, the pipe will be closed, and attempting to write to this output stream will cause an exception to be thrown. The pipe's input stream will continue to consume the data that has been written; if all is consumed it will return -1 from its read methods, unless if close(IOException) is called with a non-null error.

This method is like close(IOException), except it does not change the exception thrown from the pipe's input stream's methods. This allows the use of close(IOException) inside try-with-resources blocks without the automatic closing resetting the error.

It is possible to call close() and close(IOException) several times. This can be used to change or clear the exception to throw when reading from the pipe's input stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

close

public void close(IOException error)

Closes this output stream. After calling this method, the pipe will be closed, and attempting to write to this output stream will cause an exception to be thrown. If an exception is given, attempting to read from the pipe's input stream will cause this exception to be thrown. Otherwise, the pipe's input stream will continue to consume the data that has been written; if all is consumed it will return -1 from its read methods.

It is possible to call close() and close(IOException) several times. This can be used to change or clear the exception to throw when reading from the pipe's input stream.

Parameters:

error - If not null, the exception to throw when reading from the pipe's input stream. Otherwise, the input stream will continue to consume the data that has been written.