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

クラスFilterReader

  • すべての実装されたインタフェース:
    Closeable, AutoCloseable, Readable
    直系の既知のサブクラス:
    PushbackReader

    public abstract class FilterReader
extends Reader
    フィルタ処理された文字列ストリームを読み込むための抽象クラスです。 抽象クラスFilterReaderそのものが、格納されているストリームにすべての要求を渡すデフォルトのメソッドを提供します。 FilterReaderのサブクラスは、これらのメソッドの一部をオーバーライドし、追加のメソッドやフィールドを提供することもできます。
    導入されたバージョン:
    1.1

    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      protected Reader in
      ベースとなる文字入力ストリームです。

      • クラス java.io.Readerから継承されたフィールド

        lock

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

      コンストラクタ 
      修飾子 コンストラクタ 説明
      protected FilterReader​(Reader in)
      フィルタ処理された新しいリーダーを作成します。

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 具象メソッド 
      修飾子と型 メソッド 説明
      void close​()
      ストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。
      void mark​(int readAheadLimit)
      ストリームの現在位置にマークを設定します。
      boolean markSupported​()
      このストリームがmark()オペレーションをサポートするかどうかを判定します。
      int read​()
      単一の文字を読み込みます。
      int read​(char[] cbuf, int off, int len)
      配列の一部に文字を読み込みます。
      boolean ready​()
      このストリームが読込み可能かどうかを判定します。
      void reset​()
      ストリームをリセットします。
      long skip​(long n)
      文字をスキップします。

    • フィールドの詳細

      • in

        protected Reader in
        ベースとなる文字入力ストリームです。

    • コンストラクタの詳細

      • FilterReader

        protected FilterReader​(Reader in)
        フィルタ処理された新しいリーダーを作成します。
        パラメータ:
        in - ベースとなるストリームを提供するReaderオブジェクト。
        例外:
        NullPointerException - inがnullである場合

    • メソッドの詳細

      • read

        public int read​()
         throws IOException
        単一の文字を読み込みます。
        オーバーライド:
        read、クラス: Reader
        戻り値:
        0 - 65535 (0x00-0xffff)の範囲の整数としての、読み込まれた文字。ストリームの終わりに達した場合は -1
        例外:
        IOException - 入出力エラーが発生した場合

      • read

        public int read​(char[] cbuf,
                int off,
                int len)
         throws IOException
        配列の一部に文字を読み込みます。
        定義:
        read、クラス: Reader
        パラメータ:
        cbuf - 転送先バッファ
        off - 文字の格納開始オフセット
        len - 読み込む文字の最大数
        戻り値:
        読み込まれた文字数。ストリームの終わりに達した場合は -1
        例外:
        IOException - 入出力エラーが発生した場合
        IndexOutOfBoundsException - I/Oエラーが発生した場合

      • skip

        public long skip​(long n)
          throws IOException
        文字をスキップします。
        オーバーライド:
        skip、クラス: Reader
        パラメータ:
        n - スキップする文字数
        戻り値:
        実際にスキップした文字数
        例外:
        IOException - 入出力エラーが発生した場合

      • ready

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

      • markSupported

        public boolean markSupported​()
        このストリームがmark()オペレーションをサポートするかどうかを判定します。
        オーバーライド:
        markSupported、クラス: Reader
        戻り値:
        このストリームがmarkオペレーションをサポートする場合に限りtrue。

      • mark

        public void mark​(int readAheadLimit)
          throws IOException
        ストリームの現在位置にマークを設定します。
        オーバーライド:
        mark、クラス: Reader
        パラメータ:
        readAheadLimit - マークを保持しながら読み込むことができる文字数の上限。 この数の文字を読み込んだあとでストリームをリセットしようとすると失敗する場合がある。
        例外:
        IOException - 入出力エラーが発生した場合

      • reset

        public void reset​()
           throws IOException
        ストリームをリセットします。
        オーバーライド:
        reset、クラス: Reader
        例外:
        IOException - 入出力エラーが発生した場合

      • close

        public void close​()
           throws IOException
        次のクラスからコピーされた説明: Reader
        ストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。 ストリームが閉じられたあとにread()、ready()、mark()、reset()、またはskip()を呼び出すと、IOExceptionがスローされます。 すでに閉じられているストリームを閉じても、何の影響もありません。
        定義:
        close、インタフェース: AutoCloseable
        定義:
        close、インタフェース: Closeable
        定義:
        close、クラス: Reader
        例外:
        IOException - 入出力エラーが発生した場合