クラスFilterReader

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

  • フィールドのサマリー

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

    クラスリーダーで宣言されたフィールド

    lock
    修飾子と型
    フィールド
    説明
    protected Object
    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)
    文字をスキップします。

    クラスReaderで宣言されたメソッド

    nullReader, of, read, read, readAllAsString, readAllLines, transferTo
    修飾子と型
    メソッド
    説明
    static Reader
    nullReader()
    文字を読み取らない新しいReaderを返します。
    static Reader
    of(CharSequence cs)
    CharSequenceから文字を読み取るReaderを返します。
    int
    read(char[] cbuf)
    配列に文字を読み込みます。
    int
    read(CharBuffer target)
    指定されたcharバッファにcharを読み込みます。
    String
    readAllAsString()
    残りの文字をすべて文字列に読み込みます。
    List<String>
    readAllLines()
    残りの文字をすべてテキスト行として読み取ります。
    long
    transferTo(Writer out)
    このリーダーからすべての文字を読み込み、指定されたライターに読み込まれた順番で書き込みます。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • フィールド詳細

    • 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
      配列の一部に文字を読み込みます。 このメソッドは入力の一部が有効になるか、入出力エラーが発生するか、あるいはストリームの終わりに達するまでブロックします。

      lenが0の場合、文字は読み取られず、0が返されます。そうしないと、少なくとも1文字の読取りが試行されます。 ストリームが終了しているため、使用できる文字がない場合、値-1が返されます。そうしないと、少なくとも1つの文字が読み取られ、cbufに格納されます。

      定義:
      read、クラスReader
      パラメータ:
      cbuf - 転送先バッファ
      off - 文字の格納開始オフセット
      len - 読み込む文字の最大数
      戻り値:
      読み込まれた文字数。ストリームの終わりに達した場合は -1
      スロー:
      IndexOutOfBoundsException - offが負、lenが負、またはlenがcbuf.length - offより大きい場合
      IOException - 入出力エラーが発生した場合

    • skip

      public long skip(long n) throws IOException
      文字をスキップします。 このメソッドは、文字が読み込まれるか、入出力エラーが発生するか、あるいはストリームの終わりに達するまでブロックします。 このメソッドを呼び出す前にストリームがすでに終了している場合は、文字はスキップされず、ゼロが返されます。
      オーバーライド:
      skip、クラスReader
      パラメータ:
      n - スキップする文字数
      戻り値:
      実際にスキップした文字数
      スロー:
      IllegalArgumentException - nが負の値で、含まれるReaderのskipメソッドがネガティブ・パラメータに対してIllegalArgumentExceptionをスローする場合
      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 - 入出力エラーが発生した場合