モジュール java.base
パッケージ java.io

クラスPipedReader

java.lang.Object
java.io.Reader
java.io.PipedReader
すべての実装されたインタフェース:
Closeable, AutoCloseable, Readable
public class PipedReader
extends Reader
パイプによる文字入力ストリームです。
導入されたバージョン:
1.1

  • フィールドのサマリー

    クラス java.io.Readerで宣言されたフィールド

    lock

  • コンストラクタのサマリー

    コンストラクタ
    コンストラクタ 説明
    PipedReader()
    PipedReaderを、まだ接続されないように作成します。
    PipedReader​(int pipeSize)
    PipedReaderを、まだconnectedではない状態で作成します。その際、指定されたパイプ・サイズをパイプのバッファに使用します。
    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, nullReader, read, read, reset, skip, transferTo

    クラス 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()
      PipedReaderを、まだ接続されないように作成します。 使用前に、それをPipedWriterに接続する必要があります。

    • PipedReader

      public PipedReader​(int pipeSize)
      PipedReaderを、まだconnectedではない状態で作成します。その際、指定されたパイプ・サイズをパイプのバッファに使用します。 使用前に、それをPipedWriterに接続する必要があります。
      パラメータ:
      pipeSize - パイプのバッファのサイズ。
      例外:
      IllegalArgumentException - pipeSize <= 0の場合。
      導入されたバージョン:
      1.6

  • メソッドの詳細

    • connect

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

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

      snk.connect(src)

      または 

      src.connect(snk)

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

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

    • read

      public int read() throws IOException
      パイプで連結されたストリームからデータの次の文字を読み込みます。 ストリームの終わりに達したために読み込む文字がない場合は、値-1が返されます。 入力データが読み込めるようになるか、ストリームの終わりが検出されるか、または例外が発生するまで、このメソッドはブロックされます。
      オーバーライド:
      read、クラス: Reader
      戻り値:
      データの次の文字。ストリームの終わりに達した場合は-1。
      例外:
      IOException - パイプが brokenの状態である場合、unconnectedの状態である場合、閉じられている場合、または入出力エラーが発生した場合。

    • read

      public int read​(char[] cbuf, int off, int len) throws IOException
      最大len文字のデータを、このパイプで連結されたストリームから文字配列に読み込みます。 データ・ストリームの終わりに達した場合、またはlenバイトがパイプのバッファ・サイズを超えている場合、len文字より少ないデータが読み込まれます。 このメソッドは、少なくとも1文字の入力を利用できるまでブロックします。
      定義:
      read、クラス: Reader
      パラメータ:
      cbuf - データの読込み先のバッファ。
      off - データの開始オフセット。
      len - 読み込まれる最大文字数。
      戻り値:
      バッファに読み込まれた文字の合計数。ストリームの終わりに達してデータがない場合は-1。
      例外:
      IOException - パイプが brokenの状態である場合、unconnectedの状態である場合、閉じられている場合、または入出力エラーが発生した場合。
      IndexOutOfBoundsException - offが負の場合、またはlenが負の場合、またはlenがcbuf.length - offより大きい場合

    • ready

      public boolean ready() throws IOException
      このストリームが読込み可能かどうかを判定します。 パイプで連結された文字ストリームは、循環バッファが空でない場合に読み込むことができます。
      オーバーライド:
      ready、クラス: Reader
      戻り値:
      次のread()が入力をブロックしないことが確実な場合はtrue、そうでない場合はfalse。 falseが返されても、次の読込みが確実にブロックするというわけでない。
      例外:
      IOException - パイプが brokenの状態である場合、unconnectedの状態である場合、または閉じられている場合。

    • close

      public void close() throws IOException
      パイプによるストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。
      定義:
      close、インタフェース: AutoCloseable
      定義:
      close、インタフェース: Closeable
      定義:
      close、クラス: Reader
      例外:
      IOException - 入出力エラーが発生した場合。