com.github.robtimus.io.stream

Class PipeInputStream

java.lang.Object

java.io.InputStream

com.github.robtimus.io.stream.PipeInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class PipeInputStream
extends InputStream

An input stream that reads from a BinaryPipe.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
int	available()
void	close() Closes this input stream.
void	close(IOException error) Closes this input stream.
BinaryPipe	pipe() Returns the pipe that this input stream is reading from.
int	read()
int	read(byte[] b, int off, int len)
long	skip(long n)

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset

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 input stream is reading from.

Returns:

The pipe that this input stream is reading from.

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()

Closes this input stream. After calling this method, the pipe will be closed, and attempting to write to the pipe's output stream will cause an exception to be thrown. When reading from this input stream, -1 is returned, except if an exception is set using PipeOutputStream.close(IOException).

This method is like close(IOException), except it does not change the exception thrown from the pipe's output 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 the exception to throw when writing to the pipe's output stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

close

public void close(IOException error)

Closes this input stream. After calling this method, the pipe will be closed, and attempting to write to the pipe's output stream will cause an exception to be thrown. When reading from this input stream, -1 is returned, except if an exception is set using PipeOutputStream.close(IOException).

It is possible to call close() and close(IOException) several times. This can be used to change the exception to throw when writing to the pipe's output stream.

Parameters:

error - If not null, the exception to throw when writing to the pipe's output stream. Otherwise an exception is thrown that indicates the stream is closed.