com.github.robtimus.io.stream

Class PipeReader

java.lang.Object

java.io.Reader

com.github.robtimus.io.stream.PipeReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class PipeReader
extends Reader

A reader that reads from a TextPipe.

Author:

Rob Spoor

Field Summary

Fields inherited from class java.io.Reader

lock

Method Summary

Modifier and Type	Method and Description
void	close() Closes this reader.
void	close(IOException error) Closes this reader.
TextPipe	pipe() Returns the pipe that this reader is reading from.
int	read()
int	read(char[] cbuf, int off, int len)
boolean	ready()
long	skip(long n)

Methods inherited from class java.io.Reader

mark, markSupported, read, read, reset

Methods inherited from class java.lang.Object

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

Method Detail

pipe

public TextPipe pipe()

Returns the pipe that this reader is reading from.

Returns:

The pipe that this reader is reading from.

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class Reader

Throws:

IOException

ready

public boolean ready()
              throws IOException

Overrides:

ready in class Reader

Throws:

IOException

close

public void close()

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

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

close

public void close(IOException error)

Closes this reader. After calling this method, the pipe will be closed, and attempting to write to the pipe's writer will cause an exception to be thrown. When reading from this reader, -1 is returned, except if an exception is set using PipeWriter.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 writer.

Parameters:

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