java.io

Class PipedWriter

Implemented Interfaces:
Appendable, AutoCloseable, Closeable, Flushable

public class PipedWriter
extends Writer

This class writes its chars to a PipedReader to which it is connected.

It is highly recommended that a PipedWriter and its connected PipedReader be in different threads. If they are in the same thread, read and write operations could deadlock the thread.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

PipedWriter()
Create an unconnected PipedWriter.
PipedWriter(PipedReader sink)
Create a new PipedWriter instance to write to the specified PipedReader.

Method Summary

void
close()
This method closes this stream so that no more data can be written to it.
void
connect(PipedReader sink)
Connects this object to the specified PipedReader object.
void
flush()
This method does nothing.
void
write(char[] buffer, int offset, int len)
This method writes len chars of data from the char array buf starting at index offset in the array to the stream.
void
write(int b)
Write a single char of date to the stream.

Methods inherited from class java.io.Writer

append, append, append, close, flush, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PipedWriter

public PipedWriter()
Create an unconnected PipedWriter. It must be connected to a PipedReader using the connect method prior to writing any data or an exception will be thrown.

PipedWriter

public PipedWriter(PipedReader sink)
            throws IOException
Create a new PipedWriter instance to write to the specified PipedReader. This stream is then ready for writing.
Parameters:
sink - The PipedReader to connect this stream to.
Throws:
IOException - If sink has already been connected to a different PipedWriter.

Method Details

close

public void close()
            throws IOException
This method closes this stream so that no more data can be written to it. Any further attempts to write to this stream may throw an exception
Specified by:
close in interface Closeable
close in interface AutoCloseable
Overrides:
close in interface Writer
Throws:
IOException - If an error occurs

connect

public void connect(PipedReader sink)
            throws IOException
Connects this object to the specified PipedReader object. This stream will then be ready for writing.
Parameters:
sink - The PipedReader to connect this stream to
Throws:
IOException - If the stream has not been connected or has been closed.

flush

public void flush()
            throws IOException
This method does nothing.
Specified by:
flush in interface Flushable
Overrides:
flush in interface Writer
Throws:
IOException - If the stream is closed.

write

public void write(char[] buffer,
                  int offset,
                  int len)
            throws IOException
This method writes len chars of data from the char array buf starting at index offset in the array to the stream. Note that this method will block if the PipedReader to which this object is connected has a buffer that cannot hold all of the chars to be written.
Overrides:
write in interface Writer
Parameters:
buffer - The array containing chars to write to the stream.
offset - The index into the array to start writing chars from.
len - The number of chars to write.
Throws:
IOException - If the stream has not been connected or has been closed.

write

public void write(int b)
            throws IOException
Write a single char of date to the stream. Note that this method will block if the PipedReader to which this object is connected has a full buffer.
Overrides:
write in interface Writer
Parameters:
b - The char of data to be written, passed as an int.
Throws:
IOException - If the stream has not been connected or has been closed.

PipedWriter.java -- Write portion of piped character streams. Copyright (C) 1998, 2000, 2001, 2003 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.