java.lang.Object
java.io.Reader
java.io.PipedReader
- All Implemented Interfaces:
- Closeable,- AutoCloseable,- Readable
Piped character-input streams.
- Since:
- 1.1
- 
Field Summary
- 
Constructor SummaryConstructorsConstructorDescriptionCreates aPipedReaderso that it is not yet connected.PipedReader(int pipeSize) Creates aPipedReaderso that it is not yetconnectedand uses the specified pipe size for the pipe's buffer.PipedReader(PipedWriter src) Creates aPipedReaderso that it is connected to the piped writersrc.PipedReader(PipedWriter src, int pipeSize) Creates aPipedReaderso that it is connected to the piped writersrcand uses the specified pipe size for the pipe's buffer.
- 
Method SummaryModifier and TypeMethodDescriptionvoidclose()Closes this piped stream and releases any system resources associated with the stream.voidconnect(PipedWriter src) Causes this piped reader to be connected to the piped writersrc.intread()Reads the next character of data from this piped stream.intread(char[] cbuf, int off, int len) Reads characters into a portion of an array.booleanready()Tell whether this stream is ready to be read.Methods declared in class java.io.Readermark, markSupported, nullReader, read, read, reset, skip, transferTo
- 
Constructor Details- 
PipedReaderCreates aPipedReaderso that it is connected to the piped writersrc. Data written tosrcwill then be available as input from this stream.- Parameters:
- src- the stream to connect to.
- Throws:
- IOException- if an I/O error occurs.
 
- 
PipedReaderCreates aPipedReaderso that it is connected to the piped writersrcand uses the specified pipe size for the pipe's buffer. Data written tosrcwill then be available as input from this stream.- Parameters:
- src- the stream to connect to.
- pipeSize- the size of the pipe's buffer.
- Throws:
- IOException- if an I/O error occurs.
- IllegalArgumentException- if- pipeSize <= 0.
- Since:
- 1.6
 
- 
PipedReaderpublic PipedReader()
- 
PipedReaderpublic PipedReader(int pipeSize) Creates aPipedReaderso that it is not yetconnectedand uses the specified pipe size for the pipe's buffer. It must be connected to aPipedWriterbefore being used.- Parameters:
- pipeSize- the size of the pipe's buffer.
- Throws:
- IllegalArgumentException- if- pipeSize <= 0.
- Since:
- 1.6
 
 
- 
- 
Method Details- 
connectCauses this piped reader to be connected to the piped writersrc. If this object is already connected to some other piped writer, anIOExceptionis thrown.If srcis an unconnected piped writer andsnkis an unconnected piped reader, they may be connected by either the call:snk.connect(src)or the call: src.connect(snk)The two calls have the same effect. - Parameters:
- src- The piped writer to connect to.
- Throws:
- IOException- if an I/O error occurs.
 
- 
readReads the next character of data from this piped stream. If no character is available because the end of the stream has been reached, the value-1is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.- Overrides:
- readin class- Reader
- Returns:
- the next character of data, or -1if the end of the stream is reached.
- Throws:
- IOException- if the pipe is- broken,- unconnected, closed, or an I/O error occurs.
 
- 
readReads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.If lenis zero, then no characters are read and0is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value-1is returned; otherwise, at least one character is read and stored intocbuf.Fewer than lencharacters will be read iflenexceeds the pipe's buffer size.- Specified by:
- readin class- Reader
- Parameters:
- cbuf- Destination buffer
- off- Offset at which to start storing characters
- len- Maximum number of characters to read
- Returns:
- The number of characters read, or -1 if the end of the stream has been reached
- Throws:
- IndexOutOfBoundsException- If- offis negative, or- lenis negative, or- lenis greater than- cbuf.length - off
- IOException- if the pipe is- broken,- unconnected, closed, or an I/O error occurs.
 
- 
readyTell whether this stream is ready to be read. A piped character stream is ready if the circular buffer is not empty.- Overrides:
- readyin class- Reader
- Returns:
- True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.
- Throws:
- IOException- if the pipe is- broken,- unconnected, or closed.
 
- 
closeCloses this piped stream and releases any system resources associated with the stream.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Specified by:
- closein class- Reader
- Throws:
- IOException- if an I/O error occurs.
 
 
-