java.io

クラス BufferedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.BufferedInputStream

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

Closeable、AutoCloseable

public class BufferedInputStream
extends FilterInputStream

BufferedInputStream は、ほかの入力ストリームに機能、特に入力をバッファーに格納する機能と mark および reset メソッドをサポートする機能を追加します。BufferedInputStream が作成されると、内部バッファー配列が作成されます。ストリームのバイトが読み込まれるかスキップされると、格納されている入力ストリームから必要に応じて一度に多数のバイトが内部バッファーに補充されます。mark オペレーションは入力ストリームの特定位置を記憶します。reset オペレーションは、格納されている入力ストリームから新しいバイトが取得される前に、最後に実行された mark オペレーション以降に読み込まれたすべてのバイトを再読み込みします。

導入されたバージョン:

JDK1.0

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected byte[]	buf データを格納する内部バッファー配列です。
protected int	count バッファー中の最後の有効バイトインデックスよりも 1 つ大きな数値を持つインデックスです。
protected int	marklimit mark メソッドが呼び出され、かつ、後続の reset メソッドの呼び出しが失敗する前の状態で先読み可能な最大数です。
protected int	markpos 最後に mark メソッドが呼び出されたときの pos フィールドの値です。
protected int	pos バッファー内の現在位置です。

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

in

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

コンストラクタ

コンストラクタと説明
BufferedInputStream(InputStream in) BufferedInputStream を作成し、その引数である入力ストリーム in をあとで使用できるように保存します。
BufferedInputStream(InputStream in, int size) 指定されたバッファーサイズを持つ BufferedInputStream を作成し、その引数である入力ストリーム in をあとで使用できるように保存します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
int	available() この入力ストリームのメソッドの次の呼び出しによって、ブロックせずにこの入力ストリームから読み込むことができる (またはスキップできる) 推定バイト数を返します。
void	close() この入力ストリームを閉じて、そのストリームに関連するすべてのシステムリソースを解放します。
void	mark(int readlimit) InputStream の mark メソッドの汎用規約を参照してください。
boolean	markSupported() この入力ストリームが mark および reset メソッドをサポートしているかどうかを判定します。
int	read() InputStream の read メソッドの汎用規約を参照してください。
int	read(byte[] b, int off, int len) このバイト入力ストリームからバイトを読み取って、指定されたバイト配列に指定のオフセットから挿入します。
void	reset() InputStream の reset メソッドの汎用規約を参照してください。
long	skip(long n) InputStream の skip メソッドの汎用規約を参照してください。

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

read

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

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

フィールドの詳細

buf

protected volatile byte[] buf

データを格納する内部バッファー配列です。必要に応じて、異なるサイズのほかの配列で置き換えられます。

count

protected int count

バッファー中の最後の有効バイトインデックスよりも 1 つ大きな数値を持つインデックスです。この値の範囲は、常に 0 から buf.length です。要素 buf[0] から buf[count-1] には、ベースとなる入力ストリームから取得されたバッファリングされた入力データが格納されます。

pos

protected int pos

バッファー内の現在位置です。buf 配列の、次に読み込まれる文字データのインデックスです。

この値の範囲は、常に 0 から count です。この値が count より小さい場合、入力される次のバイトは buf[pos] です。count に等しい場合、次の read オペレーションまたは skip オペレーションは格納されている入力ストリームからこれ以降のバイトを読み込む必要があります。

関連項目:

buf

markpos

protected int markpos

最後に mark メソッドが呼び出されたときの pos フィールドの値です。

この値の範囲は、常に -1 から pos です。入力ストリームにマーク位置がない場合、このフィールドは -1 です。入力ストリームにマーク位置がある場合、reset オペレーションの実行後に入力される最初のバイトは buf[markpos] です。markpos が -1 ではない場合、buf[markpos] から buf[pos-1] の位置にあるすべてのバイトはバッファー配列に残っていなければいけません (ただし、count、pos、markpos の値に適切な調整を施せば、バッファー配列内の別の位置に移動できる)。pos と markpos の差が marklimit を超えないかぎり、これらのバイトは破棄されません。

関連項目:

mark(int), pos

marklimit

protected int marklimit

mark メソッドが呼び出され、かつ、後続の reset メソッドの呼び出しが失敗する前の状態で先読み可能な最大数です。pos と markpos の差が marklimit を超えると、markpos が -1 に設定され、マークは破棄されます。

関連項目:

mark(int), reset()

コンストラクタの詳細

BufferedInputStream

public BufferedInputStream(InputStream in)

BufferedInputStream を作成し、その引数である入力ストリーム in をあとで使用できるように保存します。内部バッファー配列が作成され、buf に格納されます。

パラメータ:

in - ベースとなる入力ストリーム。

BufferedInputStream

public BufferedInputStream(InputStream in,
                   int size)

指定されたバッファーサイズを持つ BufferedInputStream を作成し、その引数である入力ストリーム in をあとで使用できるように保存します。長さ size の内部バッファー配列が作成され、buf に格納されます。

パラメータ:

in - ベースとなる入力ストリーム。

size - バッファーサイズ。

例外:

IllegalArgumentException - size が 0 以下の場合。

メソッドの詳細

read

public int read()
         throws IOException

InputStream の read メソッドの汎用規約を参照してください。

オーバーライド:

read、クラス: FilterInputStream

戻り値:

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

例外:

IOException - この入力ストリームがその close() メソッドの呼び出しによって閉じられた場合、または入出力エラーが発生した場合。

関連項目:

FilterInputStream.in

read

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

このバイト入力ストリームからバイトを読み取って、指定されたバイト配列に指定のオフセットから挿入します。

このメソッドは、InputStream クラスの対応する read メソッドの汎用規約を実装します。より高い利便性のため、このメソッドはベースとなるストリームの read メソッドを繰り返し呼び出して、できるだけ多くのバイト数を読み込もうとします。この read の反復は、次の条件の 1 つが true になるまで行われます。

• 指定されたバイト数が読み込まれた。
• ベースとなるストリームの read メソッドが、ファイルの終わりを示す -1 を返した。
• ベースとなるストリームの available メソッドが、それ以上の入力要求がブロックされることを示すゼロを返した。

ベースとなるストリームの最初の read がファイルの終わりを示す -1 を返すと、このメソッドは -1 を返します。そうでない場合、このメソッドは実際に読み込まれたバイト数を返します。

このクラスのサブクラスは、同じ方法でできるだけ多くのバイト数を読み込むことが推奨されます。ただし、これは必須ではありません。

オーバーライド:

read、クラス: FilterInputStream

パラメータ:

b - 転送先バッファー。

off - バイトの格納開始オフセット。

len - 読み込むバイトの最大数。

戻り値:

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

例外:

IOException - この入力ストリームがその close() メソッドの呼び出しによって閉じられた場合、または入出力エラーが発生した場合。

関連項目:

FilterInputStream.in

skip

public long skip(long n)
          throws IOException

InputStream の skip メソッドの汎用規約を参照してください。

オーバーライド:

skip、クラス: FilterInputStream

パラメータ:

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

戻り値:

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

例外:

IOException - ストリームがシークをサポートしない場合、この入力ストリームが close() メソッドの呼び出しによって閉じられた場合、または入出力エラーが発生した場合。

available

public int available()
              throws IOException

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

このメソッドは、バッファーの中に残っている読み込み可能なバイトの総数 (count - pos)、および in.available() 呼び出しの結果を返します。

オーバーライド:

available、クラス: FilterInputStream

戻り値:

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

例外:

IOException - この入力ストリームがその close() メソッドの呼び出しによって閉じられた場合、または入出力エラーが発生した場合。

mark

public void mark(int readlimit)

InputStream の mark メソッドの汎用規約を参照してください。

オーバーライド:

mark、クラス: FilterInputStream

パラメータ:

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

関連項目:

reset()

reset

public void reset()
           throws IOException

InputStream の reset メソッドの汎用規約を参照してください。

markpos が -1 である (マークが設定されていないか、マークが無効になっている) 場合、IOException がスローされます。そうでない場合、pos は markpos に一致するように設定されます。

オーバーライド:

reset、クラス: FilterInputStream

例外:

IOException - このストリームにマークが付いていない場合、マークが無効な場合、ストリームが close() メソッドの呼び出しによって閉じられた場合、または入出力エラーが発生した場合。

関連項目:

mark(int)

markSupported

public boolean markSupported()

この入力ストリームが mark および reset メソッドをサポートしているかどうかを判定します。BufferedInputStream の markSupported メソッドは true を返します。

オーバーライド:

markSupported、クラス: FilterInputStream

戻り値:

このストリームの型が mark および reset メソッドをサポートしているかどうかを示す boolean。

関連項目:

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

close

public void close()
           throws IOException

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

定義:

close、インタフェース: Closeable

定義:

close、インタフェース: AutoCloseable

オーバーライド:

close、クラス: FilterInputStream

例外:

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

関連項目:

FilterInputStream.in