Java : FilterReader - API使用例

FilterReader (Java SE 19 & JDK 19) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様のおともにどうぞ。

概要

フィルタ処理された文字列ストリームを読み込むための抽象クラスです。抽象クラスFilterReaderそのものが、格納されているストリームにすべての要求を渡すデフォルトのメソッドを提供します。

クラス構成

FilterReader は、Reader オブジェクトをラップするだけのクラスです。
PushbackReader のスーパークラスとして使われています。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

try (final var reader = new MyReader(new StringReader("abc"))) {
    System.out.printf("%c%n", reader.read()); // a
    System.out.printf("%c%n", reader.read()); // b
    System.out.printf("%c%n", reader.read()); // c
    System.out.println(reader.read()); // -1
}

フィールド

protected Reader in

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

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }

    Reader getIn() {
        return in;
    }
}

final var sr = new StringReader("abc");
try (final var reader = new MyReader(sr)) {
    System.out.println(reader.getIn() == sr); // true
}

Readerで宣言されたフィールド

lock

「Java API 使用例 : Reader」をご参照ください。

コンストラクタ

FilterReader (Reader in)

フィルタ処理された新しいリーダーを作成します。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

try (final var reader = new MyReader(new StringReader("abc"))) {
    System.out.printf("%c%n", reader.read()); // a
    System.out.printf("%c%n", reader.read()); // b
    System.out.printf("%c%n", reader.read()); // c
    System.out.println(reader.read()); // -1
}

メソッド

void close ()

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

可能であれば try-with-resources文を使うことをおすすめします。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

try (final var reader = new MyReader(new StringReader("abc"))) {
    System.out.printf("%c%n", reader.read()); // a
    System.out.printf("%c%n", reader.read()); // b
    System.out.printf("%c%n", reader.read()); // c
    System.out.println(reader.read()); // -1
}

try-with-resources文を使わない例です。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

final var reader = new MyReader(new StringReader("abc"));
try {
    System.out.printf("%c%n", reader.read()); // a
    System.out.printf("%c%n", reader.read()); // b
    System.out.printf("%c%n", reader.read()); // c
    System.out.println(reader.read()); // -1
} finally {
    reader.close();
}

void mark (int readAheadLimit)

ストリームの現在位置にマークを設定します。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

try (final var reader = new MyReader(new BufferedReader(new StringReader("abcde")))) {
    System.out.printf("%c%n", reader.read()); // a
    System.out.printf("%c%n", reader.read()); // b
    System.out.printf("%c%n", reader.read()); // c

    reader.mark(3);

    System.out.printf("%c%n", reader.read()); // d
    System.out.printf("%c%n", reader.read()); // e
    System.out.println(reader.read()); // -1

    reader.reset();

    System.out.printf("%c%n", reader.read()); // d
    System.out.printf("%c%n", reader.read()); // e
    System.out.println(reader.read()); // -1

    reader.reset();
    reader.mark(2);

    System.out.printf("%c%n", reader.read()); // d
    System.out.printf("%c%n", reader.read()); // e
    System.out.println(reader.read()); // -1

    try {
        // readAheadLimit に達してリセットしようとすると例外が発生します。
        reader.reset();
    } catch (IOException e) {
        System.out.println("IOException! : " + e.getMessage());
    }

    // 結果
    // ↓
    //IOException! : Mark invalid
}

boolean markSupported ()

このストリームがmark()オペレーションをサポートするかどうかを判定します。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

{
    final var path = Path.of("R:", "java-work", "aaa.txt");
    System.out.println(path); // R:\java-work\aaa.txt

    Files.writeString(path, "abcd");

    try (final var reader = new MyReader(Files.newBufferedReader(path))) {
        System.out.println(reader.markSupported()); // true
    }
}
{
    try (final var reader = new MyReader(new StringReader("abcd"))) {
        System.out.println(reader.markSupported()); // true
    }
}
{
    final var url = new URL("https://example.com/");
    try (final var reader = new MyReader(new InputStreamReader(url.openStream()))) {
        System.out.println(reader.markSupported()); // false
    }
}

int read ()

単一の文字を読み込みます。

このメソッドの使用例は、FilterReader(Reader in) にまとめて記載しました。
そちらのAPI使用例をご参照ください。

int read (char[] cbuf, int off, int len)

配列の一部に文字を読み込みます。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

try (final var reader = new MyReader(new StringReader("abcdefg"))) {
    final var cbuf = new char[5];

    System.out.println(reader.read(cbuf, 0, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [a,  ,  ,  ,  ]

    System.out.println(reader.read(cbuf, 0, 2)); // 2
    System.out.println(Arrays.toString(cbuf)); // [b, c,  ,  ,  ]

    System.out.println(reader.read(cbuf, 0, 3)); // 3
    System.out.println(Arrays.toString(cbuf)); // [d, e, f,  ,  ]

    System.out.println(reader.read(cbuf, 0, 4)); // 1
    System.out.println(Arrays.toString(cbuf)); // [g, e, f,  ,  ]

    System.out.println(reader.read(cbuf, 0, 5)); // -1
    System.out.println(Arrays.toString(cbuf)); // [g, e, f,  ,  ]
}

try (final var reader = new MyReader(new StringReader("abcde"))) {
    final var cbuf = new char[5];

    System.out.println(reader.read(cbuf, 4, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [ ,  ,  ,  , a]

    System.out.println(reader.read(cbuf, 3, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [ ,  ,  , b, a]

    System.out.println(reader.read(cbuf, 2, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [ ,  , c, b, a]

    System.out.println(reader.read(cbuf, 1, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [ , d, c, b, a]

    System.out.println(reader.read(cbuf, 0, 1)); // 1
    System.out.println(Arrays.toString(cbuf)); // [e, d, c, b, a]
}

try (final var reader = new MyReader(new StringReader("abcdefg"))) {
    final var cbuf = new char[3];

    System.out.println(reader.read(cbuf, 0, 3)); // 3
    System.out.println(Arrays.toString(cbuf)); // [a, b, c]

    //reader.read(cbuf, 0, 4); // IndexOutOfBoundsException
    //reader.read(cbuf, 3, 1); // IndexOutOfBoundsException
}

boolean ready ()

このストリームが読込み可能かどうかを判定します。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

final var path = Path.of("R:", "java-work", "aaa.txt");
System.out.println(path); // R:\java-work\aaa.txt

Files.writeString(path, "abc");

try (final var reader = new MyReader(Files.newBufferedReader(path))) {
    System.out.println(reader.ready()); // true
    System.out.printf("%c%n", reader.read()); // a

    System.out.println(reader.ready()); // true
    System.out.printf("%c%n", reader.read()); // b

    System.out.println(reader.ready()); // true
    System.out.printf("%c%n", reader.read()); // c

    System.out.println(reader.ready()); // false
    System.out.println(reader.read()); // -1
}

void reset ()

ストリームをリセットします。

このメソッドの使用例は、mark(int readAheadLimit) にまとめて記載しました。
そちらのAPI使用例をご参照ください。

long skip (long n)

文字をスキップします。

class MyReader extends FilterReader {
    MyReader(Reader in) {
        super(in);
    }
}

try (final var reader = new MyReader(new StringReader("abcdefghij"))) {
    System.out.printf("%c%n", reader.read()); // a

    System.out.println(reader.skip(1)); // 1
    System.out.printf("%c%n", reader.read()); // c

    System.out.println(reader.skip(2)); // 2
    System.out.printf("%c%n", reader.read()); // f

    System.out.println(reader.skip(3)); // 3
    System.out.printf("%c%n", reader.read()); // j

    System.out.println(reader.skip(1)); // 0
    System.out.println(reader.read()); // -1
}

try (final var reader = new MyReader(new StringReader("abcde"))) {
    System.out.printf("%c%n", reader.read()); // a

    System.out.println(reader.skip(10)); // 4
    System.out.println(reader.read()); // -1
}

Readerで宣言されたメソッド

nullReader, read, read, transferTo