java.io
クラス DataInputStream

java.lang.Object
  java.io.InputStream
      java.io.DataInputStream

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

DataInput

public class DataInputStream
extends InputStream
implements DataInput

入力ストリームを受け取り、その入力ストリームから DataInput インタフェースの定義に従ってデータを読み出す処理を提供します。 このクラスで取り扱うデータを出力ストリームへ書き込む場合は DataOutputStream クラスを使用すると最小限のコードで処理を記述できます。

関連項目:

DataOutputStream

in

protected InputStream in

データを読み出す入力ストリームを保持しています。

DataInputStream

public DataInputStream(InputStream is)

データを読み出す入力ストリームを受け取ってオブジェクトを構築します。

パラメータ:

is - データを読み出す入力ストリームを渡します。

read

public int read()
         throws IOException

保持している入力ストリームからデータを１バイト読み出します。 読み出したデータは 0 〜 255 の int 型の値として返します。 入力ストリームが終端に達し、読み出すデータが存在しない場合は -1 を返します。

このメソッドは単純に in.read() を呼び出し、その結果を返します。 詳しい説明は InputStream クラスの read() メソッドを参照してください。

定義:

クラス InputStream 内の read

戻り値:

入力ストリームから読み出したデータを返します。

例外:

IOException - データの読み出し時に何らかの障害が発生した場合に throw します。

read

public final int read(byte[] data)
               throws IOException

保持している入力ストリームから指定された byte 配列へデータを読み出します。 このメソッドは data.length が示すバイト数のデータの読み出しが完了するか、入力ストリームが終端に達するかあるいは例外が throw されるまでブロックします。

このメソッドは単純に in.read(data) を呼び出し、その結果を返します。 詳しい説明は InputStream クラスの read(byte[]) メソッドを参照してください。

オーバーライド:

クラス InputStream 内の read

パラメータ:

data - 読み出したデータを格納する byte 配列を渡します。

戻り値:

読み出したデータのバイト数あるいは -1 を返します。

例外:

IOException - データの読み出し時に何らかの障害が発生した場合に throw します。

NullPointerException - data に null が渡された場合に throw します。

read

public final int read(byte[] data,
                      int index,
                      int length)
               throws IOException

保持している入力ストリームから指定バイト数分のデータを指定された byte 配列の指定位置へ読み出します。 このメソッドは指定バイト数のデータの読み出しが完了するか、入力ストリームが終端に達するかあるいは例外が throw されるまでブロックします。

このメソッドは単純に in.read(data, index, length) を呼び出し、その結果を返します。 詳しい説明は InputStream クラスの read(byte[], int int) メソッドを参照してください。

オーバーライド:

クラス InputStream 内の read

パラメータ:

data - 読み出したデータを書き込む byte 配列を渡します。

index - 読み出したデータを書き込み開始する byte 配列の位置を渡します。

length - 読み出すデータのバイト数を渡します。

戻り値:

読み出したデータのバイト数あるいは -1 を返します。

例外:

IOException - 初回のデータ読み出しが入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

NullPointerException - data に null が渡された場合に throw します。

IndexOutOfBoundsException - index が負数あるいは index + length が data のサイズを超える場合に throw します。

readFully

public final void readFully(byte[] data)
                     throws IOException

保持している入力ストリームから指定された byte 配列へデータを読み出します。 読み出すデータの量は data.length が示すサイズとなります。

定義:

インタフェース DataInput 内の readFully

パラメータ:

data - 読み出したデータを格納する byte 配列を渡します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

NullPointerException - data に null が渡された場合に throw します。

readFully

public final void readFully(byte[] data,
                            int index,
                            int length)
                     throws IOException

入力ストリームから指定バイト数分のデータを指定された byte 配列の指定位置へ読み出します。 このメソッドは指定バイト数のデータの読み出しが完了するか例外が throw されるまでブロックします。

定義:

インタフェース DataInput 内の readFully

パラメータ:

data - 読み出したデータを書き込む byte 配列を渡します。

index - 読み出したデータを書き込み開始する byte 配列の位置を渡します。

length - 読み出すデータのバイト数を渡します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

NullPointerException - data に null が渡された場合に throw します。

IndexOutOfBoundsException - index が負数あるいは index + length が data のサイズを超える場合に throw します。

skipBytes

public final int skipBytes(int length)
                    throws IOException

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

定義:

インタフェース DataInput 内の skipBytes

パラメータ:

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

戻り値:

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

例外:

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

readBoolean

public final boolean readBoolean()
                          throws IOException

保持している入力ストリームから 1 バイトのデータを読み出し、その値が 0 以外なら true を 0 ならば false を返します。

定義:

インタフェース DataInput 内の readBoolean

戻り値:

読み込んだデータが 0 以外ならば true を、0 ならば false を返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

関連項目:

DataOutputStream.writeBoolean(boolean)

readByte

public final byte readByte()
                    throws IOException

入力ストリームから 1 バイトのデータを読み出し、その値を byte 型の値として返します。

定義:

インタフェース DataInput 内の readByte

戻り値:

読み出したデータを返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

関連項目:

DataOutputStream.writeByte(int)

readUnsignedByte

public final int readUnsignedByte()
                           throws IOException

保持している入力ストリームから 1 バイトのデータを読み出し、その値を int 型へ０拡張して返します。

定義:

インタフェース DataInput 内の readUnsignedByte

戻り値:

読み出したデータを返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

関連項目:

DataOutputStream.writeByte(int)

readShort

public final short readShort()
                      throws IOException

保持している入力ストリームから 2 バイトのデータを読み出し、ビッグエンディアンとして評価した short 値を返します。

定義:

インタフェース DataInput 内の readShort

戻り値:

読み出したデータを返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

関連項目:

DataOutputStream.writeShort(int)

readUnsignedShort

public final int readUnsignedShort()
                            throws IOException

保持している入力ストリームから 2 バイトのデータを読み出し、その値をビッグエンディアンで組み立て０拡張した値を返します。

定義:

インタフェース DataInput 内の readUnsignedShort

戻り値:

読み出したデータを返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

関連項目:

DataOutputStream.writeShort(int)

readChar

public final char readChar()
                    throws IOException

保持している入力ストリームから 2 バイトのデータを読み出し、ビッグエンディアンとして評価した char 値を返します。

定義:

インタフェース DataInput 内の readChar

戻り値:

読み出したデータを返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

関連項目:

DataOutputStream.writeChar(int)

readInt

public final int readInt()
                  throws IOException

保持している入力ストリームから 4 バイトのデータを読み出し、ビッグエンディアンとして評価した int 値を返します。

定義:

インタフェース DataInput 内の readInt

戻り値:

読み出したデータを返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

関連項目:

DataOutputStream.writeInt(int)

readLong

public final long readLong()
                    throws IOException

保持している入力ストリームから 8 バイトのデータを読み出し、ビッグエンディアンとして評価した long 値を返します。

定義:

インタフェース DataInput 内の readLong

戻り値:

読み出したデータを返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

関連項目:

DataOutputStream.writeLong(long)

readUTF

public final String readUTF()
                     throws IOException

保持している入力ストリームから Java 修正 UTF-8 形式の文字列を読み出し、String オブジェクトとして返します。

定義:

インタフェース DataInput 内の readUTF

戻り値:

読み出した結果文字列を返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

UTFDataFormatException - 入力ストリームから読み出したデータが Java 修正 UTF-8 形式として不正な場合に throw します。

関連項目:

DataOutputStream.writeUTF(java.lang.String)

readUTF

public static final String readUTF(DataInput di)
                            throws IOException

パラメータとして渡された DataInput オブジェクトから Java 修正 UTF-8 形式の文字列を読み出し、String オブジェクトとして返します。

例外:

EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

UTFDataFormatException - 入力ストリームから読み出したデータが Java 修正 UTF-8 形式として不正な場合に throw します。

導入されたバージョン:

CLDC-1.0.2

関連項目:

DataOutputStream.writeUTF(java.lang.String)

skip

public long skip(long length)
          throws IOException

保持している入力ストリームから指定バイト数分のデータを読み飛ばします。 しかし、実際に読み飛ばすことのできるデータ数がさまざまな要因（入力ストリームが終端に達するなど）によって指定されたバイト数に達しないこともあります。 戻り値には実際に読み飛ばしたバイト数を返します。

オーバーライド:

クラス InputStream 内の skip

パラメータ:

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

例外:

IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

available

public int available()
              throws IOException

保持している次回の処理において、入力ストリームがブロックすることなく取り扱うことのできる、つまり読み出したり読み飛ばしたりすることが可能なバイト数を返します。

オーバーライド:

クラス InputStream 内の available

戻り値:

次回の呼び出しで入力ストリームがブロックすることなく取り扱えるバイト数を返します。

例外:

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

close

public void close()
           throws IOException

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

オーバーライド:

クラス InputStream 内の close

例外:

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

mark

public void mark(int length)

保持している入力ストリームが指している現在位置をマークします。 reset() メソッドを呼び出すと入力ストリームが次回データを取り出す位置がマークした位置へ戻ります。 これにより、入力ストリームの特定部分を繰り返し読むことができます。

オーバーライド:

クラス InputStream 内の mark

パラメータ:

length - 現在位置をマークしてから読み出される可能性のある最大バイト数を渡します。

reset

public void reset()
           throws IOException

保持している入力ストリームが次回データを読み出す位置を、最後に mark(int) メソッドによってマークした位置あるいは実装に固有な規定位置に戻します。

オーバーライド:

クラス InputStream 内の reset

例外:

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

関連項目:

markSupported(), mark(int)

markSupported

public boolean markSupported()

保持している入力ストリームが mark(int) メソッドと reset() メソッドによる操作に対応しているかどうかを返します。

オーバーライド:

クラス InputStream 内の markSupported

戻り値:

入力ストリームが mark(int) メソッドと reset() メソッドによる操作をサポートしている場合は true を、サポートしていない場合は false を返します。

関連項目:

mark(int), reset()