com.github.robtimus.io.stream

Class PipeWriter

java.lang.Object

java.io.Writer

com.github.robtimus.io.stream.PipeWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public final class PipeWriter
extends Writer

A writer that writes to a TextPipe.

Author:

Rob Spoor

Field Summary

Fields inherited from class java.io.Writer

lock

Method Summary

Modifier and Type	Method and Description
PipeWriter	append(char c)
PipeWriter	append(CharSequence csq)
PipeWriter	append(CharSequence csq, int start, int end)
void	close() Closes this writer.
void	close(IOException error) Closes this writer.
void	flush()
TextPipe	pipe() Returns the pipe that this writer is writing to.
void	write(char[] cbuf, int off, int len)
void	write(int b)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

write, write

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 writer is writing to.

Returns:

The pipe that this writer is writing to.

write

public void write(int b)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

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

Specified by:

write in class Writer

Throws:

IOException

write

public void write(String str,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

append

public PipeWriter append(CharSequence csq)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public PipeWriter append(CharSequence csq,
                         int start,
                         int end)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public PipeWriter append(char c)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()

Closes this writer. After calling this method, the pipe will be closed, and attempting to write to this writer will cause an exception to be thrown. The pipe's reader 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 reader'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 reader.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

close

public void close(IOException error)

Closes this writer. After calling this method, the pipe will be closed, and attempting to write to this writer will cause an exception to be thrown. If an exception is given, attempting to read from the pipe's reader will cause this exception to be thrown. Otherwise, the pipe's reader 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 reader.

Parameters:

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