java.io
クラス FilterReader

java.lang.Object
  java.io.Reader
      java.io.FilterReader

すべての実装されたインタフェース:

Closeable, Readable

直系の既知のサブクラス:

PushbackReader

public abstract class FilterReader
extends Reader

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

導入されたバージョン:

JDK1.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) 文字をスキップします。

クラス java.io.Reader から継承されたメソッド

read, read

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

in

protected Reader in

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

コンストラクタの詳細

FilterReader

protected FilterReader(Reader in)

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

パラメータ:

in - 基本となるストリームを提供する Reader オブジェクト

例外:

NullPointerException - in が null の場合

メソッドの詳細

read

public int read()
         throws IOException

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

オーバーライド:

クラス Reader 内の read

戻り値:

0 〜 65535 (0x00-0xffff) の範囲の整数としての、読み込まれた文字。ストリームの終わりに達した場合は -1

例外:

IOException - 入出力エラーが発生した場合

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException

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

定義:

クラス Reader 内の read

パラメータ:

cbuf - 転送先バッファー

off - 文字の格納開始オフセット

len - 読み込む文字の最大数

戻り値:

読み込まれた文字数。ストリームの終わりに達した場合は -1

例外:

IOException - 入出力エラーが発生した場合

skip

public long skip(long n)
          throws IOException

文字をスキップします。

オーバーライド:

クラス Reader 内の skip

パラメータ:

n - スキップする文字数

戻り値:

実際にスキップした文字数

例外:

IOException - 入出力エラーが発生した場合

ready

public boolean ready()
              throws IOException

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

オーバーライド:

クラス Reader 内の ready

戻り値:

次の read() が入力をブロックしないことが確実な場合は true、そうでない場合は false。false が返されても、次の読み込みが確実にブロックするというわけでない

例外:

IOException - 入出力エラーが発生した場合

markSupported

public boolean markSupported()

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

オーバーライド:

クラス Reader 内の markSupported

戻り値:

このストリームが mark オペレーションをサポートする場合に限り true

mark

public void mark(int readAheadLimit)
          throws IOException

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

オーバーライド:

クラス Reader 内の mark

パラメータ:

readAheadLimit - マークを保持しながら読み込むことができる文字数の上限。この数の文字を読み込んだあとでストリームをリセットしようとすると失敗する場合がある

例外:

IOException - 入出力エラーが発生した場合

reset

public void reset()
           throws IOException

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

オーバーライド:

クラス Reader 内の reset

例外:

IOException - 入出力エラーが発生した場合

close

public void close()
           throws IOException

クラス Reader の記述:

ストリームを閉じて、それに関連するすべてのシステムリソースを解放します。ストリームが閉じられたあとに read()、ready()、mark()、reset()、または skip() を呼び出すと、IOException がスローされます。すでに閉じられているストリームを閉じても、何の影響もありません。

定義:

インタフェース Closeable 内の close

定義:

クラス Reader 内の close

例外:

IOException - 入出力エラーが発生した場合