java.io
類別 PipedReader

java.lang.Object
  java.io.Reader
      java.io.PipedReader

所有已實作的介面：

Closeable, Readable

public class PipedReader
extends Reader

傳送的字元輸入串流。

從以下版本開始：

JDK1.1

欄位摘要

從類別 java.io.Reader 繼承的欄位

lock

建構子摘要

PipedReader()
創建尚未連接的 PipedReader。

PipedReader(int pipeSize)
創建一個尚未連接的 PipedReader，並對管道緩衝區使用指定的管道大小。

PipedReader(PipedWriter src)
創建連接到傳送 writer src 的 PipedReader。

PipedReader(PipedWriter src, int pipeSize)
創建一個 PipedReader，使其連接到管道 writer src，並對管道緩衝區使用指定的管道大小。

方法摘要

void	close() 關閉此傳送串流並釋放與該串流相關的所有系統資源。
void	connect(PipedWriter src) 使此傳送 reader 連接到傳送 writer src。
int	read() 讀取此傳送串流中的下一個資料字元。
int	read(char[] cbuf, int off, int len) 將此傳送串流中最多 len 個資料字元讀入字元陣列。
boolean	ready() 告知是否準備讀取此串流。

從類別 java.io.Reader 繼承的方法

mark, markSupported, read, read, reset, skip

從類別 java.lang.Object 繼承的方法

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

建構子詳細資訊

PipedReader

public PipedReader(PipedWriter src)
            throws IOException

創建連接到傳送 writer src 的 PipedReader。寫入 src 的資料稍後將用作此串流的輸入。

參數：

src - 要連接的串流。

拋出：

IOException - 如果發生 I/O 錯誤。

PipedReader

public PipedReader(PipedWriter src,
                   int pipeSize)
            throws IOException

創建一個 PipedReader，使其連接到管道 writer src，並對管道緩衝區使用指定的管道大小。寫入到 src 的資料將可用作此串流的輸入。

參數：

src - 要連接的串流。

pipeSize - 管道緩衝區的大小。

拋出：

IOException - 如果發生 I/O 錯誤。

IllegalArgumentException - 如果 pipeSize <= 0。

從以下版本開始：

1.6

PipedReader

public PipedReader()

創建尚未連接的 PipedReader。使用前必須將其連接到 PipedWriter。

PipedReader

public PipedReader(int pipeSize)

創建一個尚未連接的 PipedReader，並對管道緩衝區使用指定的管道大小。使用前必須將其連接到 PipedWriter。

參數：

pipeSize - 管道緩衝區的大小。

拋出：

IllegalArgumentException - 如果 pipeSize <= 0。

從以下版本開始：

1.6

方法詳細資訊

connect

public void connect(PipedWriter src)
             throws IOException

使此傳送 reader 連接到傳送 writer src。如果此物件已經連接到其他某個傳送 writer，則拋出 IOException。

如果 src 是未連接的傳送 writer，而 snk 是未連接的傳送 reader，則可以通過以下調用之一連接它們：

snk.connect(src) 

或：

src.connect(snk) 

這兩個調用的效果相同。

參數：

src - 要連接的傳送 writer。

拋出：

IOException - 如果發生 I/O 錯誤。

read

public int read()
         throws IOException

讀取此傳送串流中的下一個資料字元。如果因為已經到達串流的末尾而沒有可用的字元，則返回值 -1。在輸入資料可用、檢測到串流的末尾或者拋出異常之前，此方法一直阻塞。

覆寫：

類別 Reader 中的 read

返回：

下一個資料字元，如果到達串流的末尾，則返回 -1。

拋出：

IOException - 如果管道處於 broken、未連接或關閉狀態，或者發生 I/O 錯誤。

read

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

將此傳送串流中最多 len 個資料字元讀入字元陣列。如果已到達資料串流的末尾，或者 len 超出管道緩衝區大小，則讀取的字元數少於 len。此方法一直阻塞，直到至少一個輸入字元可用。

指定者：

類別 Reader 中的 read

參數：

cbuf - 讀入資料的緩衝區。

off - 資料的初始偏移量。

len - 讀取的最大字元數。

返回：

讀入緩衝區的總字元數，如果因為已經到達串流末尾而不再有資料可用，則返回 -1。

拋出：

IOException - 如果管道處於 broken、未連接或關閉狀態，或者發生 I/O 錯誤。

ready

public boolean ready()
              throws IOException

告知是否準備讀取此串流。如果循環緩衝區不為空，則傳送字元串流已做好被讀取的準備。

覆寫：

類別 Reader 中的 ready

返回：

如果保證下一個 read() 不阻塞輸入，則返回 True，否則返回 false。注意，返回 false 並不保證阻塞下一次讀取。

拋出：

IOException - 如果管道處於 broken、未連接或關閉狀態。

close

public void close()
           throws IOException

關閉此傳送串流並釋放與該串流相關的所有系統資源。

指定者：

介面 Closeable 中的 close

指定者：

類別 Reader 中的 close

拋出：

IOException - 如果發生 I/O 錯誤。