Unofficial
"CLDC 1.1
+ MIDP 2.0"
API Reference.
(日本語版)

java.io
クラス DataInputStream

java.lang.Object
  上位を拡張 java.io.InputStream
      上位を拡張 java.io.DataInputStream
すべての実装されたインタフェース:
DataInput

public class DataInputStream
extends InputStream
implements DataInput

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

導入されたバージョン:
CLDC 1.0
関連項目:
DataOutputStream

フィールドの概要
protected  InputStream in
          データを読み出す入力ストリームを保持しています。
 
コンストラクタの概要
DataInputStream(InputStream is)
          データを読み出す入力ストリームを受け取ってオブジェクトを構築します。
 
メソッドの概要
 int available()
          次回の処理において、保持している入力ストリームがブロックすることなく取り扱うことのできる、つまり読み出したり読み飛ばしたりすることが可能なバイト数を返します。
 void close()
          保持している入力ストリームをクローズし、関連するリソースを全て開放します。
 void mark(int length)
          保持している入力ストリームが指している現在位置をマークします。
 boolean markSupported()
          保持している入力ストリームが mark(int) メソッドと reset() メソッドによる操作に対応しているか否かを返します。
 int read()
          保持している入力ストリームからデータを1バイト読み出します。
 int read(byte[] data)
          保持している入力ストリームから指定された byte 配列へデータを読み出します。
 int read(byte[] data, int index, int length)
          保持している入力ストリームから指定バイト数分のデータを指定された byte 配列の指定位置へ読み出します。
 boolean readBoolean()
          保持している入力ストリームから 1 バイトのデータを読み出し、その値が 0 以外なら true0 ならば false を返します。
 byte readByte()
          入力ストリームから 1 バイトのデータを読み出し、その値を byte 型の値として返します。
 char readChar()
          保持している入力ストリームから 2 バイトのデータを読み出し、ビッグ・エンディアンとして評価した char 値を返します。
 double readDouble()
          保持している入力ストリームから 8 バイトのデータを読み出し、IEEE 754 浮動小数点の倍精度フォーマット(Double Format)のビット配列とみなした double 値を返します。
 float readFloat()
          保持している入力ストリームから 4 バイトのデータを読み出し、IEEE 754 浮動小数点の単精度フォーマット(Single Format)のビット配列とみなした float 値を返します。
 void readFully(byte[] data)
          保持している入力ストリームから指定された byte 配列へデータを読み出します。
 void readFully(byte[] data, int index, int length)
          入力ストリームから指定バイト数分のデータを指定された byte 配列の指定位置へ読み出します。
 int readInt()
          保持している入力ストリームから 4 バイトのデータを読み出し、ビッグ・エンディアンとして評価した int 値を返します。
 long readLong()
          保持している入力ストリームから 8 バイトのデータを読み出し、ビッグ・エンディアンとして評価した long 値を返します。
 short readShort()
          保持している入力ストリームから 2 バイトのデータを読み出し、ビッグ・エンディアンとして評価した short 値を返します。
 int readUnsignedByte()
          保持している入力ストリームから 1 バイトのデータを読み出し、その値を int 型へ0拡張して返します。
 int readUnsignedShort()
          保持している入力ストリームから 2 バイトのデータを読み出し、その値をビッグ・エンディアンで組み立て0拡張した値を返します。
 String readUTF()
          保持している入力ストリームから Java 修正 UTF-8 形式の文字列を読み出し、String オブジェクトとして返します。
static String readUTF(DataInput di)
          パラメータとして渡された DataInput オブジェクトから Java 修正 UTF-8 形式の文字列を読み出し、String オブジェクトとして返します。
 void reset()
          保持している入力ストリームが次回データを読み出す位置を、最後に mark(int) メソッドによってマークした位置あるいは実装に固有な規定位置に戻します。
 long skip(long length)
          保持している入力ストリームから指定バイト数分のデータを読み飛ばします。
 int skipBytes(int length)
          保持している入力ストリームから指定バイト数分のデータを読み飛ばします。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

in

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

コンストラクタの詳細

DataInputStream

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

パラメータ:
is - データを読み出す入力ストリームを渡します。
メソッドの詳細

read

public int read()
         throws IOException

保持している入力ストリームからデータを1バイト読み出します。 読み出したデータは 0255int 型の値として返します。 入力ストリームが終端に達し、読み出すデータが存在しない場合は -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 - datanull が渡された場合に 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 - datanull が渡された場合に throw します。
IndexOutOfBoundsException - index が負数あるいは index + lengthdata のサイズを超える場合に throw します。

readFully

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

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

定義:
インタフェース DataInput 内の readFully
パラメータ:
data - 読み出したデータを格納する byte 配列を渡します。
例外:
EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。
IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。
NullPointerException - datanull が渡された場合に 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 - datanull が渡された場合に throw します。
IndexOutOfBoundsException - index が負数あるいは index + lengthdata のサイズを超える場合に throw します。

skipBytes

public final int skipBytes(int length)
                    throws IOException

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

定義:
インタフェース DataInput 内の skipBytes
パラメータ:
length - 読み飛ばすバイト数を渡します。
戻り値:
実際に読み飛ばしたバイト数を返します。
例外:
IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

readBoolean

public final boolean readBoolean()
                          throws IOException

保持している入力ストリームから 1 バイトのデータを読み出し、その値が 0 以外なら true0 ならば 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 型へ0拡張して返します。

定義:
インタフェース 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 バイトのデータを読み出し、その値をビッグ・エンディアンで組み立て0拡張した値を返します。

定義:
インタフェース 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 します。
関連項目:

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()

readFloat

public final float readFloat()
                      throws IOException

保持している入力ストリームから 4 バイトのデータを読み出し、IEEE 754 浮動小数点の単精度フォーマット(Single Format)のビット配列とみなした float 値を返します。

定義:
インタフェース DataInput 内の readFloat
戻り値:
読み出したデータを返します。
例外:
EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。
IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。
導入されたバージョン:
CLDC 1.1
関連項目:
DataOutputStream.writeFloat(float)

readDouble

public final double readDouble()
                        throws IOException

保持している入力ストリームから 8 バイトのデータを読み出し、IEEE 754 浮動小数点の倍精度フォーマット(Double Format)のビット配列とみなした double 値を返します。

定義:
インタフェース DataInput 内の readDouble
戻り値:
読み出したデータを返します。
例外:
EOFException - データを最後まで読み出す前に入力ストリームが終端に達した場合に throw します。
IOException - 入力ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。
導入されたバージョン:
CLDC 1.1
関連項目:
DataOutputStream.writeDouble(double)

Unofficial
"CLDC 1.1
+ MIDP 2.0"
API Reference.
(日本語版)

公式仕様書原文の著作権表記等(※):

Mobile Information Device Profile Specification ("Specification")
Version: 2.0
Status: FCS
Release: November 5, 2002

Copyright 2002 Sun Microsystems, Inc. and Motorola, Inc.
All rights reserved.
※ただしこの API リファレンスは英語仕様を一語一句正確に翻訳したものではなく、一度私が英語の仕様原文を読んだ上で元の意味と構造をなるべく保つように書き起こしたものです。このため一部は完全に異なる説明となっています。また CLDC 1.1 部分は同仕様の範囲外であるため、まったく参考とはしていません。

※仕様書のライセンス上、問題は無いと考えておりますが、万が一問題があるとお考えの関係者の方がいらっしゃいましたらメールにて連絡をいただけると幸いに存じます(第一言語に日本語、第二言語に英語を希望しますが、返信は基本的に日本語で行います)。

この API リファレンスは仕様書の日本語版という位置づけでは作成していませんし、仕様書ほど厳格でもありません。MUST、SHOULD、MAY などの仕様の条件を強調する文を維持していません(反映すらしていない個所もあります)。仮想マシンおよび MIDP の実装のために使用することは避けてください。そのような用途には必ず公式仕様書原文そのものを用いるべきです。
この API リファレンスに記載されている内容は"さかきけい"が Sun Microsystems, Inc や Motorola, Inc、Java Community Process が公開している各種公式資料を元に、独自に調査・編集したものであり、Sun Microsystems, Inc や Motorola, Inc、Java Community Process 等とは一切関係ありません。したがってこの API リファレンスに関する問い合わせを関係各社等に対して行うことを固く禁じます。
また、記載された内容には既知か否かに関らず誤りが含まれる可能性があり、一切保証はありません。本 API リファレンスを使用した結果、不利益が生じたとしても"さかきけい"は一切の責任を負いません。
許可無く公開/非公開および Internet/Intranet/LAN を問わず他サイトに転載すること、複写および複製すること、ローカル・ファイル等に保存することを禁じます。


Copyright© 2001-2002,2005-2009,2011 by KEI SAKAKI.
ALL RIGHTS RESERVED.
無断転載を禁じます。

Unofficial "CLDC 1.0 + MIDP 1.0" API Reference はこちらです。