JavaTM 2 Platform
Standard Ed. 5.0

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(PipedWriter src)
          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()
PipedReader を、まだ接続されていない状態で作成します。これを使うには、PipedWriter に接続する必要があります。

関連項目:
connect(java.io.PipedWriter), PipedWriter.connect(java.io.PipedReader)
メソッドの詳細

connect

public void connect(PipedWriter src)
             throws IOException
パイプによるリーダを、パイプによるライター src に接続させます。このオブジェクトがほかのパイプライターにすでに接続されている場合は、IOException がスローされます。

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

snk.connect(src) 

または

src.connect(snk) 

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

パラメータ:
src - パイプによる接続先のライター
例外:
IOException - 入出力エラーが発生した場合

read

public int read()
         throws IOException
パイプによるストリームから、次の文字を読み込みます。ストリームの終わりに達してバイトがない場合は、値 -1 が返されます。このメソッドは、入力データが読み込めるようになるか、ストリームの終わりが検出されるか、または例外がスローされるまでブロックします。スレッドがデータ文字を接続済みのパイプによるライターに提供していたが、そのスレッドがもう生存していない場合は、IOException がスローされます。

オーバーライド:
クラス Reader 内の read
戻り値:
データの次の文字。ストリームの終わりに達した場合は -1
例外:
IOException - パイプが壊れている場合

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException
パイプによるストリームから len 文字までのデータを、文字の配列に読み込みます。データストリームの終わりに達した場合は、len より少ない文字数しか読み込まれません。このメソッドは、少なくとも 1 文字が入力できるようになるまでブロックします。スレッドが接続済みのパイプ出力ストリームにデータ文字を提供していたが、そのスレッドがもう存在していない場合は、IOException がスローされます。

定義:
クラス Reader 内の read
パラメータ:
cbuf - データの読み込み先のバッファ
off - データの開始オフセット
len - 読み込まれる最大文字数
戻り値:
バッファに読み込まれた文字の合計数。ストリームの終わりに達してデータがない場合は -1
例外:
IOException - 入出力エラーが発生した場合

ready

public boolean ready()
              throws IOException
このストリームが読み込める状態になっているかどうかを通知します。パイプによる文字ストリームは、循環バッファが空でない場合に読み込むことができます。

オーバーライド:
クラス Reader 内の ready
戻り値:
次の read() が入力をブロックしないのが確実な場合は true、そうでない場合は false。false が返されても、次の読み込みが確実にブロックするというわけでない
例外:
IOException - 入出力エラーが発生した場合

close

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

定義:
インタフェース Closeable 内の close
定義:
クラス Reader 内の close
例外:
IOException - 入出力エラーが発生した場合

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。