java.io
クラス ByteArrayInputStream

java.lang.Object
  java.io.InputStream
      java.io.ByteArrayInputStream

public class ByteArrayInputStream
extends InputStream

任意の byte 配列を入力ストリームとして取り扱う機能を提供するクラスです。

buf

protected byte[] buf

このストリームの作成時に渡されたバイト配列への参照を保持しています。 ストリームは pos の位置から指定バイト数分読み出します。 byte 配列の最後の位置は count に設定されています。

pos

protected int pos

このストリームから次に読み出す buf 内の位置を保持しています。 この値は常に正数であり、count よりも小さい値でなければなりません。

mark

protected int mark

このストリームでマークしている byte 配列内の位置を保持しています。 マークは mark メソッドで行い、マーク位置への読み出し位置へ戻す操作は reset() メソッドによって行います。 このクラスの構築時にはデフォルトで 0 が設定されています。

count

protected int count

このストリームで保持している読み出し対象配列の最後の位置より 1 大きい値を保持しています。 この値は正数で buf のサイズ以内の値でなければなりません。

ByteArrayInputStream

public ByteArrayInputStream(byte[] data)

入力ストリームとして取り扱うデータを受け取ってオブジェクトを構築します。 読み出し開始位置は受け取ったデータの先頭、読み出し終了位置はデータの最後となります。 つまり、pos = 0、count = data.length に設定します。 読み取り対象のデータのコピーは作成されません。

パラメータ:

data - 入力ストリームとして取り扱う byte 配列のデータを渡します。

ByteArrayInputStream

public ByteArrayInputStream(byte[] data,
                            int index,
                            int length)

入力ストリームとして取り扱うデータを受け取ってオブジェクトを構築します。 読み取り開始位置は index、終了位置は index + length - 1 となります。 つまり、pos = index、count = index + length に設定します。 読み取り対象のデータのコピーは作成されません。

パラメータ:

data - 入力ストリームとして取り扱う byte 配列のデータを渡します。

index - 入力ストリームとして取り扱う、配列中の開始位置を渡します。

length - 入力ストリームとして取り扱う、開始位置からの長さを渡します。

read

public int read()

入力ストリームから１バイトデータを読み込み、符号なしの数値（0 〜 255）として返します。 読み出す対象のデータが存在しない場合は -1 を返します。

このメソッドはブロックしません。

定義:

クラス InputStream 内の read

戻り値:

入力ストリームから読み出した数値あるいは -1 を返します。

read

public int read(byte[] buf,
                int index,
                int length)

入力ストリームから指定バイト数のデータを指定されたバッファへ指定されたバイト数分読み出します。 入力ストリームに指定されたバイト数分のデータがない場合、入力ストリームに残っているデータのみが読み出し対象となります。 読み出したバイト数は戻り値に返します。 ただし、入力ストリームが終端に達している場合、戻り値には -1 を返します。

データの読み出し後、次回の読み出しにあわせて、pos に読み出したバイト数が加算されます。

一般に、入力ストリームからバッファへのデータのコピーには System クラスの arraycopy メソッドを使用します。

オーバーライド:

クラス InputStream 内の read

パラメータ:

buf - 入力ストリームから読み出したデータを受け取る byte 配列を渡します。

index - 入力ストリームから読み出したデータを格納する buf 内の位置を渡します。

length - 入力ストリームから読み出すバイト数を渡します。

戻り値:

入力ストリームから buf へ読み出されたバイト数あるいは -1 を返します。

skip

public long skip(long length)

入力ストリームから指定バイト数分のデータを読み飛ばします。 入力ストリームに指定されたバイト数のデータが存在しない場合は入力ストリームに存在する残りのデータを読み飛ばします。 戻り値には実際に読み飛ばしたバイト数を返します。

オーバーライド:

クラス InputStream 内の skip

パラメータ:

length - 読み飛ばすバイト数を渡します。

戻り値:

実際に読み飛ばしたバイト数を返します。

available

public int available()

入力ストリームからブロックを発生させずに読み出すことのできるバイト数を返します。 返すバイト数は count - pos の結果値となります。

オーバーライド:

クラス InputStream 内の available

戻り値:

ブロックを発生させずに読み出すことができるバイト数を返します。

markSupported

public boolean markSupported()

ByteArrayInputStream が mark メソッドおよび reset() メソッドをサポートしているかどうかを返します。 サポートしている場合は true を、サポートされていない場合は false を返します。

オーバーライド:

クラス InputStream 内の markSupported

戻り値:

mark メソッドおよび reset() メソッドをサポートしているかどうかを返します。

関連項目:

mark(int), reset()

mark

public void mark(int limitlen)

現在の読み出し位置をマークします。 マークした読み出し位置へは reset() メソッドで戻すことができます。 ByteArrayInputStream クラスではマークの初期位置は 0 が設定されています。

オーバーライド:

クラス InputStream 内の mark

パラメータ:

limitlen - ByteArrayInputStream クラスでは意味を持ちません。

関連項目:

mark, reset()

reset

public void reset()
           throws IOException

現在の読み出し位置をマークした位置へ戻します。 次回の読み出しはマークした位置からとなります。

オーバーライド:

クラス InputStream 内の reset

例外:

IOException - マークされた位置が無効となっている場合あるいはこのメソッドの操作をサポートしていない場合に throw します。

関連項目:

mark, mark(int)

close

public void close()
           throws IOException

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

オーバーライド:

クラス InputStream 内の close

例外:

IOException - 処理に伴い、入力関係で何らかの障害が発生した場合に throw します。