java.io

クラス FilterInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

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

Closeable, AutoCloseable

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

BufferedInputStream, CheckedInputStream, CipherInputStream, DataInputStream, DeflaterInputStream, DigestInputStream, InflaterInputStream, LineNumberInputStream, ProgressMonitorInputStream, PushbackInputStream

public class FilterInputStream
extends InputStream

FilterInputStream は、データの基本的なソースとして使用するためのその他の入力ストリームを格納します。データを途中で変換することや、追加機能を提供することもあります。FilterInputStream クラスそのものが、格納されている入力ストリームにすべての要求を渡すバージョンによって、InputStream のすべてのメソッドを単純にオーバーライドします。FilterInputStream のサブクラスは、これらのメソッドの一部をさらにオーバーライドすることができ、追加のメソッドやフィールドを提供することもできます。

導入されたバージョン:

JDK1.0

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected InputStream	in フィルタ処理される入力ストリームです。

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

コンストラクタ

修飾子	コンストラクタと説明
protected	FilterInputStream(InputStream in) あとで使用できるように引数 in をフィールド this.in に割り当てることによって FilterInputStream を作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
int	available() この入力ストリームのメソッドの次の呼び出し側によって、ブロックせずにこの入力ストリームから読み込むことができる (またはスキップできる) 推定バイト数を返します。
void	close() この入力ストリームを閉じて、そのストリームに関連するすべてのシステムリソースを解放します。
void	mark(int readlimit) この入力ストリームの現在位置にマークを設定します。
boolean	markSupported() この入力ストリームが mark および reset メソッドをサポートしているかどうかを判定します。
int	read() この入力ストリームからデータの次のバイトを読み込みます。
int	read(byte[] b) 最大 byte.length バイトのデータを、この入力ストリームからバイト配列に読み込みます。
int	read(byte[] b, int off, int len) 最大 len バイトのデータを、この入力ストリームからバイト配列に読み込みます。
void	reset() このストリームを、この入力ストリームで最後に mark メソッドが呼び出されたときの位置に再配置します。
long	skip(long n) 入力ストリームから n バイトのデータをスキップして破棄します。

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

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

フィールドの詳細

in

protected volatile InputStream in

フィルタ処理される入力ストリームです。

コンストラクタの詳細

FilterInputStream

protected FilterInputStream(InputStream in)

あとで使用できるように引数 in をフィールド this.in に割り当てることによって FilterInputStream を作成します。

パラメータ:

in - ベースとなる入力ストリーム。このインスタンスがベースとなるストリームなしで生成される場合は null。

メソッドの詳細

read

public int read()
         throws IOException

この入力ストリームからデータの次のバイトを読み込みます。バイト値は、0 - 255 の範囲の int として返されます。ストリームの終わりに達したために読み込むバイトがない場合は、-1 が返されます。入力データが読み込めるようになるか、ストリームの終わりが検出されるか、または例外が発生するまで、このメソッドはブロックされます。

このメソッドは単純に in.read() を実行し、その結果を返します。

定義:

read、クラス: InputStream

戻り値:

データの次のバイト。ストリームの終わりに達した場合は -1。

例外:

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

関連項目:

in

read

public int read(byte[] b)
         throws IOException

最大 byte.length バイトのデータを、この入力ストリームからバイト配列に読み込みます。このメソッドは、入力の一部が利用できるようになるまでブロックします。

このメソッドは単純に read(b, 0, b.length) の呼び出しを実行し、その結果を返します。代わりに in.read(b) が実行されないようにしてください。FilterInputStream の特定のサブクラスは、実際に使用されている実装方法に依存します。

オーバーライド:

read、クラス: InputStream

パラメータ:

b - データの読み込み先のバッファー。

戻り値:

バッファーに読み込まれたバイトの合計数。ストリームの終わりに達してデータがない場合は -1。

例外:

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

関連項目:

read(byte[], int, int)

read

public int read(byte[] b,
       int off,
       int len)
         throws IOException

最大 len バイトのデータを、この入力ストリームからバイト配列に読み込みます。len が 0 でない場合、このメソッドは入力の一部が利用できるようになるまでブロックされます。それ以外の場合、バイトは読み込まれず、0 が返されます。

このメソッドは単純に in.read(b, off, len) を実行し、その結果を返します。

オーバーライド:

read、クラス: InputStream

パラメータ:

b - データの読み込み先のバッファー。

off - 転送先配列 b の開始オフセット

len - 読み込まれる最大バイト数。

戻り値:

バッファーに読み込まれたバイトの合計数。ストリームの終わりに達してデータがない場合は -1。

例外:

NullPointerException - b が null である場合。

IndexOutOfBoundsException - off が負の値の場合、len が負の値の場合、あるいは len が b.length - off より大きい場合

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

関連項目:

in

skip

public long skip(long n)
          throws IOException

入力ストリームから n バイトのデータをスキップして破棄します。さまざまな理由から、skip メソッドは指定よりも少ないバイト数しかスキップしないことがあります。0 の場合もあります。スキップされた実際のバイト数が返されます。

このメソッドは単純に in.skip(n) を実行します。

オーバーライド:

skip、クラス: InputStream

パラメータ:

n - スキップされるバイト数。

戻り値:

実際にスキップされたバイト数。

例外:

IOException - ストリームがシークをサポートしない場合、またはその他の入出力エラーが発生した場合。

available

public int available()
              throws IOException

この入力ストリームのメソッドの次の呼び出し側によって、ブロックせずにこの入力ストリームから読み込むことができる (またはスキップできる) 推定バイト数を返します。次の呼び出し側は、同じスレッドの場合も別のスレッドの場合もあります。このような多数のバイトを 1 回で読み込んだりスキップしたりすることでブロックすることはありませんが、読み込むまたはスキップするバイト数が少なくなることがあります。

このメソッドは、in.available() の結果を返します。

オーバーライド:

available、クラス: InputStream

戻り値:

ブロックせずにこの入力ストリームから読み込むことができる (またはスキップできる) 推定バイト数。

例外:

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

close

public void close()
           throws IOException

この入力ストリームを閉じて、そのストリームに関連するすべてのシステムリソースを解放します。このメソッドは単純に in.close() を実行します。

定義:

close、インタフェース: Closeable

定義:

close、インタフェース: AutoCloseable

オーバーライド:

close、クラス: InputStream

例外:

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

関連項目:

in

mark

public void mark(int readlimit)

この入力ストリームの現在位置にマークを設定します。これに続いて reset メソッドを呼び出すと、最後にマークされた位置にこのストリームが再配置されるため、以降の読み込みでは同じバイトが再度読み込まれます。

引数 readlimit はこの入力ストリームに対して、マーク位置が無効になる前にこの引数が指定するバイト数を読み込むように指示します。

このメソッドは単純に in.mark(readlimit) を実行します。

オーバーライド:

mark、クラス: InputStream

パラメータ:

readlimit - マーク位置が無効になる前に読み込み可能なバイト数の上限。

関連項目:

in, reset()

reset

public void reset()
           throws IOException

このストリームを、この入力ストリームで最後に mark メソッドが呼び出されたときの位置に再配置します。

このメソッドは単純に in.reset() を実行します。

ストリームのマークは、ストリームに何が含まれているかをチェックするために、データを少しだけ先読みする必要がある場合に使われます。これをもっとも容易に実行する方法は、一般的なパーサーを呼び出すことです。ストリームがパーサーで取り扱えるタイプであれば、これでうまく行きます。ストリームがこのようなタイプではない場合は、パーサーは失敗した時点で例外を発生させます。readlimit バイトの範囲内でこれが発生した場合は、外部のコードでストリームをリセットし、別のパーサーを呼び出すことができます。

オーバーライド:

reset、クラス: InputStream

例外:

IOException - ストリームにマークが設定されていなかった場合、またはマークが無効になっていた場合。

関連項目:

in, mark(int)

markSupported

public boolean markSupported()

この入力ストリームが mark および reset メソッドをサポートしているかどうかを判定します。このメソッドは単純に in.markSupported() を実行します。

オーバーライド:

markSupported、クラス: InputStream

戻り値:

このストリームインスタンスが mark および reset メソッドをサポートしている場合は true、それ以外の場合は false。

関連項目:

in, InputStream.mark(int), InputStream.reset()