jp.co.intra_mart.common.aid.jdk.java.io

クラス TrimmedFilterReader

java.lang.Object

java.io.Reader

java.io.FilterReader

jp.co.intra_mart.common.aid.jdk.java.io.TrimmedFilterReader

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

Closeable, AutoCloseable, Readable

public class TrimmedFilterReader
extends FilterReader

このクラスは、基礎となる java.io.Reader をフィルタリングした Writer 機能を提供します。

フィルタ処理として、 文字入力ストリームから Java の基準に従った空白文字ではない文字を読み込みます。

導入されたバージョン:

Version 5.0

フィールドのサマリー

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

in

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

lock

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

コンストラクタ

コンストラクタと説明
TrimmedFilterReader(Reader in) Reader をフィルタリングする新しい TrimmedFilterReader を作成します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	read() 単一の文字を読み込みます。
int	read(char[] cbuf, int off, int len) 配列の一部に文字を読み込みます。

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

close, mark, markSupported, ready, reset, skip

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

read, read

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

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

コンストラクタの詳細

TrimmedFilterReader

public TrimmedFilterReader(Reader in)

Reader をフィルタリングする新しい TrimmedFilterReader を作成します。

パラメータ:

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

メソッドの詳細

read

public int read()
         throws IOException

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

文字入力ストリームから読み込んだ文字が Java の基準に従った空白文字である場合に、 次の文字を読み込みを行います。

文字の値は 0 ～ 65535 (0x00-0xffff) の範囲の値をとる int として返されます。 ストリームの終わりに達して読み込むデータがない場合は -1 を返します。

このメソッドは、入力データが読み込めるようになるか、 ストリームの終わりが検出されるか、 または例外がスローされるまでブロックします。

オーバーライド:

read クラス内 FilterReader

戻り値:

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

例外:

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

関連項目:

java.io.Reader#read()

read

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

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

入力ストリームから len 文字数分の文字を指定された文字の配列に格納します。 実際に読み込まれた文字数は整数として返されます。

このメソッドは、入力データが読み込めるようになるか、 ファイルの終わりが検出されるか、 あるいは例外がスローされるまでブロックします。

文字の配列 cbuf が null の場合は、NullPointerException がスローされます。

off が負の場合、len が負の場合、あるいは off+len が配列 cbuf の長さより大きい場合は、 IndexOutOfBoundsException がスローされます。

len が 0 の場合は、文字が読み込まれず、0 が返されます。 そうでない場合は、Java の基準に従った空白文字でない 1 文字以上の読み込み処理が行われます。 ストリームがファイルの終わりに達しているために読み込む文字がない場合は、 値 -1 が返されます。 そうでない場合は、Java の基準に従った空白文字でない len 文字数分の文字が読み込まれ、 文字の配列 cbuf に格納されます。

すべての場合において、文字 cbuf[0] ～ cbuf[off] および文字 cbuf[off+len] ～ cbuf[b.length-1] は影響を受けません。

ファイルの終わりに達している以外の理由で最初のバイトが読み込めない場合は、 IOException がスローされます。 特に、入力ストリームが閉じている場合には IOException がスローされます。

このメソッドは、単純に read() メソッドを繰り返し呼び出します。 最初の呼び出しが IOException になる場合、 その例外は呼び出し側から read(cbuf, off, len) メソッドに返されます。 read() の以降の呼び出しが IOException になった場合、 その例外はファイルの終わりが検出された場合と同じようにキャッチおよび処理されます。 つまり、その時点までに読み込まれた文字は cbuf に格納され、 例外が発生するまでに読み込まれた文字数が返されます。

オーバーライド:

read クラス内 FilterReader

パラメータ:

cbuf - 転送先バッファ

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

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

戻り値:

読み込まれた文字数。

例外:

IOException

NullPointerException

関連項目:

Reader.read(char[], int, int)