This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.io
class PipedWriter

java.lang.Object extended by java.io.Writer extended by java.io.PipedWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable

Most common way to construct:

PipedWriter writer = new PipedWriter();

Based on 60 examples


public class PipedWriter
extends Writer

Piped character-output streams.

See Also (auto-generated):

BufferedReader

PipedReader

PrintWriter


Field Summary
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary

          Creates a piped writer that is not yet connected to a piped reader.

          Creates a piped writer connected to the specified piped reader.
 
Method Summary
 void

          Closes this piped output stream and releases any system resources associated with this stream.
 void

          Connects this piped writer to a receiver.
 void

          Flushes this output stream and forces any buffered output characters to be written out.
 void
write(char[] cbuf, int off, int len)

          Writes len characters from the specified character array starting at offset off to this piped output stream.
 void
write(int c)

          Writes the specified char to the piped output 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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PipedWriter

public PipedWriter()
Creates a piped writer that is not yet connected to a piped reader. It must be connected to a piped reader, either by the receiver or the sender, before being used.


PipedWriter

public PipedWriter(PipedReader snk)
            throws IOException
Creates a piped writer connected to the specified piped reader. Data characters written to this stream will then be available as input from snk.

Parameters:
snk - The piped reader to connect to.
Throws:
IOException - if an I/O error occurs.
Method Detail

close

public void close()
           throws IOException
Closes this piped output stream and releases any system resources associated with this stream. This stream may no longer be used for writing characters.

Overrides:
close in class Writer
Throws:
IOException - if an I/O error occurs.

connect

public synchronized void connect(PipedReader snk)
                          throws IOException
Connects this piped writer to a receiver. If this object is already connected to some other piped reader, an IOException is thrown.

If snk is an unconnected piped reader and src is an unconnected piped writer, they may be connected by either the call:

 src.connect(snk)
or the call:
 snk.connect(src)
The two calls have the same effect.

Parameters:
snk - the piped reader to connect to.
Throws:
IOException - if an I/O error occurs.

flush

public synchronized void flush()
                        throws IOException
Flushes this output stream and forces any buffered output characters to be written out. This will notify any readers that characters are waiting in the pipe.

Overrides:
flush in class Writer
Throws:
IOException - if the pipe is closed, or an I/O error occurs.

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException
Writes len characters from the specified character array starting at offset off to this piped output stream. This method blocks until all the characters are written to the output stream. If a thread was reading data characters from the connected piped input stream, but the thread is no longer alive, then an IOException is thrown.

Overrides:
write in class Writer
Parameters:
cbuf - the data.
off - the start offset in the data.
len - the number of characters to write.
Throws:
IOException - if the pipe is broken, {@link #connect(java.io.PipedReader) unconnected}, closed or an I/O error occurs.

write

public void write(int c)
           throws IOException
Writes the specified char to the piped output stream. If a thread was reading data characters from the connected piped input stream, but the thread is no longer alive, then an IOException is thrown.

Implements the write method of Writer.

Overrides:
write in class Writer
Parameters:
c - the char to be written.
Throws:
IOException - if the pipe is broken, {@link #connect(java.io.PipedReader) unconnected}, closed or an I/O error occurs.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.