java.io
クラス BufferedInputStream

java.lang.Object
  java.io.InputStream
      java.io.FilterInputStream
          java.io.BufferedInputStream

public class BufferedInputStream
extends FilterInputStream

BufferedInputStream は別の入力ストリームを内部の入力ストリームとして保持して、データをバッファリングする機能、および mark と reset の機能などを追加します。

BufferedInputStream が生成されると内部にバッファ用の配列が作成されます。 バイトデータが読み込まれたりスキップされたりすると、BufferedInputStream は内部の入力ストリームから一度に多くのデータを読み込み内部バッファに格納します。 mark 操作は入力ストリーム中のアクセス位置を記憶させます。 reset 操作は、内部入力ストリームから新たなデータを取り出す前に、最近の mark 操作以降に読み出されたデータが再度読み出されるように内部状態を設定します。

コンストラクタの概要

BufferedInputStream(InputStream is)
指定された入力ストリームからデータを読み込む BufferedInputStream を生成します。

BufferedInputStream(InputStream is, int size)
指定された入力ストリームからデータを読み込む、指定されたバッファサイズの BufferedInputStream を生成します。

メソッドの概要

int	available() この入力ストリームに対して、次のメソッド呼び出しによってブロックされることなく読みだすかまたはスキップすることが可能なバイト数を返します。
void	close() この入力ストリームをクローズして、関連するリソースを解放します。
void	mark(int readlimit) この入力ストリーム中の現在のアクセス位置をマークします。
boolean	markSupported() この入力ストリームが mark メソッドと reset メソッドをサポートしているかどうかを返します。
int	read() 入力ストリームから次のバイトを読み込みます。
int	read(byte[] b, int off, int len) 最大 len バイトまでこの入力ストリームから読み込み、指定された配列の領域に格納します。
void	reset() ストリームの読み出しポジションを mark メソッドが最後に呼び出された時点の位置に戻します。
long	skip(long n) この入力ストリームから n バイト分をスキップします。

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

read

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

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

コンストラクタの詳細

BufferedInputStream

public BufferedInputStream(InputStream is)

指定された入力ストリームからデータを読み込む BufferedInputStream を生成します。 内部バッファ配列を生成して保持します。

パラメータ:

is - データを読み込む入力ストリーム

BufferedInputStream

public BufferedInputStream(InputStream is,
                           int size)

指定された入力ストリームからデータを読み込む、指定されたバッファサイズの BufferedInputStream を生成します。 size で指定されたサイズの内部バッファ配列を生成して保持します。

パラメータ:

is - データを読み込む入力ストリーム

size - バッファサイズ。 このパラメータに0を指定した場合でも例外は発生しませんが、 そのオブジェクトを使用した場合の振る舞いは保証されません。

メソッドの詳細

read

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

最大 len バイトまでこの入力ストリームから読み込み、指定された配列の領域に格納します。

このメソッドは InputStream の対応する read メソッドの規約を実装していますが、以下のように処理を最適化しています。

• len バイトがすべて内部バッファにある場合はバッファから読み出して返します。
• 内部バッファが空の場合、内部ストリームの read(byte[] b,int off,int len) メソッドで len バイトを要求し、得られたバイト列を返します。この場合入力ストリームは最低限1バイト読み込むまではブロックします。
• 内部バッファに少なくとも1バイトの読み込み済みのデータがあるが len バイトには不足する場合、内部入力ストリームの available メソッドが返すサイズまでを最大として、不足する分を入力ストリームの read(byte[] b,int off,int len) メソッドで要求し、バッファのデータと得られたバイト列とを合わせて返します。この read メソッドの呼び出しではブロックされません。

オーバーライド:

クラス FilterInputStream 内の read

パラメータ:

b - 読み込んだデータを格納するバッファ

off - データを書き込み始める、配列 b のオフセット位置

len - 読み込むバイトデータの最大長

戻り値:

バッファに格納されたバイトデータの長さ、ストリームの終端に到達したためにデータがない場合は -1

例外:

IOException - I/Oエラーが発生した場合

関連項目:

InputStream.read(byte[], int, int)

read

public int read()
         throws IOException

入力ストリームから次のバイトを読み込みます。

InputStream.read() の規約を参照してください。

このメソッドは read(byte[] b,int off,int len) メソッドで１バイト読み込んで返します。

オーバーライド:

クラス FilterInputStream 内の read

戻り値:

次のバイトデータ、またはストリームの終端に到達した場合は -1

例外:

IOException - I/Oエラーが発生した場合

available

public int available()
              throws IOException

この入力ストリームに対して、次のメソッド呼び出しによってブロックされることなく読みだすかまたはスキップすることが可能なバイト数を返します。

オーバーライド:

クラス FilterInputStream 内の available

戻り値:

この入力ストリームからブロックすることなしに読み出し可能なバイト数

例外:

IOException - I/Oエラーが発生した場合

skip

public long skip(long n)
          throws IOException

この入力ストリームから n バイト分をスキップします。

オーバーライド:

クラス FilterInputStream 内の skip

パラメータ:

n - スキップするバイト数。 このパラメータに0以下を指定した場合の振る舞いは保証されません。

戻り値:

実際にスキップしたバイト数

例外:

IOException - I/Oエラーが発生した場合

関連項目:

InputStream.skip(long)

close

public void close()
           throws IOException

この入力ストリームをクローズして、関連するリソースを解放します。

オーバーライド:

クラス FilterInputStream 内の close

例外:

IOException - I/Oエラーが発生した場合

markSupported

public boolean markSupported()

この入力ストリームが mark メソッドと reset メソッドをサポートしているかどうかを返します。 BufferedInputStream のこのメソッドの実装は true を返します。

オーバーライド:

クラス FilterInputStream 内の markSupported

戻り値:

この入力ストリームが mark メソッドと reset メソッドをサポートしている場合 true 、そうでない場合 false

mark

public void mark(int readlimit)

この入力ストリーム中の現在のアクセス位置をマークします。

InputStream.mark(int) の規約を参照してください。

オーバーライド:

クラス FilterInputStream 内の mark

パラメータ:

readlimit - マークされたアクセス位置が無効になるまで読み出し可能とする最大データバイト数

reset

public void reset()
           throws IOException

ストリームの読み出しポジションを mark メソッドが最後に呼び出された時点の位置に戻します。

InputStream.reset() の規約を参照してください。

BufferedInputStream のこのメソッドの実装では、 mark されていない状態でこのメソッドが呼び出されると IOException をスローします。

オーバーライド:

クラス FilterInputStream 内の reset

例外:

IOException - I/Oエラーが発生した場合