java.io
インタフェース DataInput

既知のサブインタフェースの一覧:

Datagram

既知の実装クラスの一覧:

DataInputStream

public interface DataInput

バイナリの入力ストリームから Java のプリミティブ型のデータの読み出しおよび Java 修正 UTF-8 形式を String オブジェクトとして取り出す機構の定義をしています。

このインタフェースの実装は以下の規定を満たす必要があります。

• 必要なデータを入力ストリームから読み出せないまま終端に達した場合、EOFException を throw しなければなりません。
• 入力ストリームが終端に達した場合以外の要因でデータの読み出しに失敗した場合、IOException を throw しなければなりません。

関連項目:

DataOutput

readFully

void readFully(byte[] data)
               throws IOException

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

データの読み出し中に入力ストリームが終端に達した場合は EOFException を throw します。 それ以外の要因で読み出しに失敗した場合は IOException を throw します。 これらの例外が throw された場合でも、そこまでに読み込んだデータは data に格納されています。

パラメータ:

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

例外:

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

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

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

readFully

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

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

このメソッドで例外が throw されるのは以下の場合です。

• データの読み出し中に入力ストリームが終端に達した場合は EOFException を throw します。
• データの読み出し中に入力ストリームが終端に達した以外の要因で読み出しに失敗した場合は IOException を throw します。
• index が負数あるいは index + length が data のサイズを超える場合は IndexOutOfBoundsException が throw されます。
• data が null 場合は NullPointerException が throw されます。

これらの例外が throw された場合でも、そこまでに読み込んだデータは data に格納される可能性があります。

パラメータ:

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

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

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

例外:

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

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

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

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

skipBytes

int skipBytes(int length)
              throws IOException

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

このメソッドは EOFException を throw することはありません。

パラメータ:

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

戻り値:

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

例外:

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

readBoolean

boolean readBoolean()
                    throws IOException

入力ストリームから 1 バイトのデータを読み出し、その値が 0 以外なら true を 0 ならば false を返します。 このメソッドは主に DataOutput インタフェースの writeBoolean メソッドで書き込まれたデータを読み出す場合に使用します。

戻り値:

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

例外:

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

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

関連項目:

DataOutput.writeBoolean(boolean)

readByte

byte readByte()
              throws IOException

入力ストリームから 1 バイトのデータを読み出し、その値を byte 型の値として返します。 このメソッドは主に DataOutput インタフェースの writeByte メソッドで書き込まれたデータを読み出す場合に使用します。

戻り値:

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

例外:

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

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

関連項目:

DataOutput.writeByte(int)

readUnsignedByte

int readUnsignedByte()
                     throws IOException

入力ストリームから 1 バイトのデータを読み出し、その値を int 型へ０拡張して返します。 このメソッドは主に DataOutput インタフェースの writeByte メソッドで書き込まれたデータを 0 〜 255 の間の数値として読み出したい場合に使用します。

戻り値:

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

例外:

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

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

関連項目:

DataOutput.writeByte(int)

readShort

short readShort()
                throws IOException

入力ストリームから 2 バイトのデータを読み出し、ビッグエンディアンとして評価した short 値を返します。 １バイト目のデータを first、２バイト目のデータを second とすると以下の様になります。

     (short) ((first & 0xff) << 8) | (second & 0xff)

このメソッドは主に DataOutput インタフェースの writeShort メソッドで書き込まれたデータを読み出す場合に使用します。

戻り値:

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

例外:

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

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

関連項目:

DataOutput.writeShort(int)

readUnsignedShort

int readUnsignedShort()
                      throws IOException

入力ストリームから 2 バイトのデータを読み出し、その値をビッグエンディアンで組み立て０拡張した値を返します。 １バイト目のデータを first、２バイト目のデータを second とすると以下の様になります。

     ((first & 0xff) << 8) | (second & 0xff)

このメソッドは主に DataOutput インタフェースの writeShort メソッドで書き込まれたデータを 0 〜 65535 の符号なしの値として読み出す場合に使用します。

戻り値:

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

例外:

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

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

関連項目:

DataOutput.writeShort(int)

readChar

char readChar()
              throws IOException

入力ストリームから 2 バイトのデータを読み出し、ビッグエンディアンとして評価した char 値を返します。 １バイト目のデータを first、２バイト目のデータを second とすると以下の様になります。

     (char) ((first & 0xff) << 8) | (second & 0xff)

このメソッドは主に DataOutput インタフェースの writeChar メソッドで書き込まれたデータを読み出す場合に使用します。

戻り値:

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

例外:

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

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

関連項目:

DataOutput.writeChar(int)

readInt

int readInt()
            throws IOException

入力ストリームから 4 バイトのデータを読み出し、ビッグエンディアンとして評価した int 値を返します。 １バイト目のデータを first、２バイト目のデータを second、３バイト目のデータを third、４バイト目のデータを fourth とすると以下の様になります。

     ((first & 0xff) << 24) | ((second & 0xff) << 16) | 
     ((third & 0xff) << 8) | (fourth & 0xff)

このメソッドは主に DataOutput インタフェースの writeInt メソッドで書き込まれたデータを読み出す場合に使用します。

戻り値:

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

例外:

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

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

関連項目:

DataOutput.writeInt(int)

readLong

long readLong()
              throws IOException

入力ストリームから 8 バイトのデータを読み出し、ビッグエンディアンとして評価した long 値を返します。 １バイト目のデータを d1、２バイト目のデータを d2、３バイト目のデータを d3、以下８バイト目まで同じとすると以下の様になります。

     ( ((long) (d1 & 0xff) << 56) | ((long) (d2 & 0xff) << 48) | 
       ((long) (d3 & 0xff) << 40) | ((long) (d4 & 0xff) << 32) |
       ((long) (d5 & 0xff) << 24) | ((long) (d1 & 0xff) << 16) |
       ((long) (d1 & 0xff) <<  8) | ((long) (d1 & 0xff)) )

このメソッドは主に DataOutput インタフェースの writeLong メソッドで書き込まれたデータを読み出す場合に使用します。

戻り値:

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

例外:

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

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

関連項目:

DataOutput.writeLong(long)

readUTF

String readUTF()
               throws IOException

入力ストリームから Java 修正 UTF-8 形式の文字列を読み出し、String オブジェクトとして返します。 このメソッドは以下の手順で Java 修正 UTF-8 の文字列を読み込みます。

1. 入力ストリームから２バイトのデータを読み出します。
2. 読み出した２バイトを readUnsignedShort() と同じ方法で評価します。この値を以下 UTF 長と呼びます。
3. 入力ストリームから UTF 超が示すバイト数を読み出します。
4. 読み出したデータを Java 修正 UTF-8 形式で Unicode へ変換します。
5. Unicode へ変換されたデータを String オブジェクトに変換します。

Java 修正 UTF-8 は以下の様に規定されています。

• '\u0001' 〜 '\u007f' の文字は以下のフォーマットで１バイトのデータとして表現されます。

  ビット	7	6	5	4	3	2	1	0
  値	0	コードの 0 〜 7 ビット

• null 文字である '\u0000' と '\u0080' 〜 '\u07ff' の文字は以下のフォーマットで２バイトのデータとして表現されます。

  １バイト目

  ビット	7	6	5	4	3	2	1	0
  値	1	1	0	コードの 6 〜 10 ビット

  ２バイト目

  ビット	7	6	5	4	3	2	1	0
  値	1	0	コードの 0 〜 5 ビット

• '\u0800' 〜 '\uffff' の文字は以下のフォーマットで３バイトのデータとして表現されます。

  １バイト目

  ビット	7	6	5	4	3	2	1	0
  値	1	1	1	0	コードの 12 〜 15 ビット

  ２バイト目

  ビット	7	6	5	4	3	2	1	0
  値	1	0	コードの 6 〜 11 ビット

  ３バイト目

  ビット	7	6	5	4	3	2	1	0
  値	1	0	コードの 0 〜 5 ビット

この Java 修正 UTF-8 は以下の点で標準 UTF-8 と異なります。

• null 文字である '\u0000' が１バイトではなく２バイトで表されます。
• 使用する形式が１バイトから３バイトのみとなっています。

null 文字を１バイトで表現しないのは Java 修正 UTF-8 符号化した際に、そのコード中に null 文字が現れないようにするためです。

このメソッドは主に DataOutput インタフェースの writeUTF メソッドで書き込まれたデータを読み出す場合に使用します。

data が null の場合、NullPointerException を throw します。

戻り値:

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

例外:

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

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

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

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

関連項目:

DataOutput.writeUTF(java.lang.String)