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()
まだ connected ではない状態で PipedReader を作成します。

PipedReader(int pipeSize)
まだ connected ではない状態で PipedReader を作成します。

PipedReader(PipedWriter src)
PipedReader を作成し、パイプで連結されたライター src に接続します。

PipedReader(PipedWriter src, int pipeSize)
PipedReader を作成し、パイプで連結されたライター src に接続します。

メソッドの概要

void	close() パイプによるストリームを閉じて、それに関連するすべてのシステムリソースを解放します。
void	connect(PipedWriter src) パイプで連結されたリーダーをパイプで連結されたライター 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

PipedReader を作成し、パイプで連結されたライター src に接続します。src に書き込まれたデータは、このストリームからの入力として使えるようになります。

パラメータ:

src - 接続先のストリーム

例外:

IOException - 入出力エラーが発生した場合

PipedReader

public PipedReader(PipedWriter src,
                   int pipeSize)
            throws IOException

PipedReader を作成し、パイプで連結されたライター src に接続します。その際、指定されたパイプサイズをパイプのバッファーに使用します。src に書き込まれたデータは、このストリームからの入力として使えるようになります。

パラメータ:

src - 接続先のストリーム

pipeSize - パイプのバッファーのサイズ

例外:

IOException - 入出力エラーが発生した場合

IllegalArgumentException - pipeSize <= 0 の場合

導入されたバージョン:

1.6

PipedReader

public PipedReader()

まだ connected ではない状態で PipedReader を作成します。使用前に、PipedWriter に対して connected の状態にする必要があります。

PipedReader

public PipedReader(int pipeSize)

まだ connected ではない状態で PipedReader を作成します。その際、指定されたパイプサイズをパイプのバッファーに使用します。使用前に、PipedWriter に対して connected の状態にする必要があります。

パラメータ:

pipeSize - パイプのバッファーのサイズ

例外:

IllegalArgumentException - pipeSize <= 0 の場合

導入されたバージョン:

1.6

メソッドの詳細

connect

public void connect(PipedWriter src)
             throws IOException

パイプで連結されたリーダーをパイプで連結されたライター src に接続します。このオブジェクトが別のパイプで連結されたライターに接続されている場合は、IOException がスローされます。

src がパイプによる未接続のパイプライターで、snk が未接続のパイプリーダーである場合、src と snk は以下の呼び出しのどちらかによって接続されます。

snk.connect(src) 

または

src.connect(snk) 

2 つの呼び出しは同じ効果を持ちます。

パラメータ:

src - パイプによる接続先のライター

例外:

IOException - 入出力エラーが発生した場合

read

public int read()
         throws IOException

パイプで連結されたストリームからデータの次の文字を読み込みます。ストリームの終わりに達したために読み込む文字がない場合は、値 -1 が返されます。入力データが読み込めるようになるか、ファイルの終わりが検出されるか、または例外が発生するまで、このメソッドはブロックされます。

オーバーライド:

クラス Reader 内の read

戻り値:

データの次の文字。ストリームの終わりに達した場合は -1

例外:

IOException - パイプが壊れている場合、unconnected の状態である場合、閉じられている場合、または入出力エラーが発生した場合

read

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

最大 len 文字までのデータを、このパイプで連結されたストリームから文字配列に読み込みます。データストリームの終わりに達した場合、または len 文字がパイプのバッファーサイズを超えている場合、len 文字より少ないデータが読み込まれます。このメソッドは、少なくとも 1 文字の入力を利用できるまでブロックします。

定義:

クラス Reader 内の read

パラメータ:

cbuf - データの読み込み先のバッファ

off - データの開始オフセット

len - 読み込まれる最大文字数

戻り値:

バッファーに読み込まれた文字の合計数。ストリームの終わりに達してデータがない場合は -1

例外:

IOException - パイプが壊れている場合、unconnected の状態である場合、閉じられている場合、または入出力エラーが発生した場合

ready

public boolean ready()
              throws IOException

このストリームが読み込み可能かどうかを判定します。パイプで連結された文字ストリームは、循環バッファーが空でない場合に読み込むことができます。

オーバーライド:

クラス Reader 内の ready

戻り値:

次の read() が入力をブロックしないことが確実な場合は true、そうでない場合は false。false が返されても、次の読み込みが確実にブロックするというわけでない

例外:

IOException - パイプが壊れている場合、unconnected の状態である場合、または閉じられている場合

close

public void close()
           throws IOException

パイプによるストリームを閉じて、それに関連するすべてのシステムリソースを解放します。

定義:

インタフェース Closeable 内の close

定義:

クラス Reader 内の close

例外:

IOException - 入出力エラーが発生した場合