java.io
インタフェース DataOutput

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

Datagram

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

DataOutputStream

public interface DataOutput

Java のプリミティブ型のデータおよび String オブジェクトが保持する文字列をバイナリの出力ストリームへ書き込む機能の定義をしています。

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

• 何らかの理由によって出力ストリームへの書き込みに失敗した場合、IOException を throw しなければなりません。

関連項目:

DataInput

write

void write(int data)
           throws IOException

出力ストリームへデータを 1 バイト書き込みます。 書き込むデータは int 型で指定しますが、実際に書き込まれるのは下位 8 ビットのみです。 残りの上位 24 ビットは処理に影響しません。

このメソッドはデータの書き込みに終了するか例外が throw されるまでブロックします。

パラメータ:

data - 書き込むデータを渡します。

例外:

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

write

void write(byte[] data)
           throws IOException

出力ストリームへ指定された byte 配列に格納されたデータを書き込みます。 このメソッドは data.length が示すデータの書き込みが完了するか、例外が throw されるまでブロックします。

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

• 何らかの理由で書き込みに失敗した場合は IOException を throw します。
• data が null 場合は NullPointerException が throw されます。

これらの例外が throw された場合でも、そこまでに書き込んだデータは取り消されません。

パラメータ:

data - 書き込むデータを格納した byte 配列を渡します。

例外:

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

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

write

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

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

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

• 何らかの理由で書き込みに失敗した場合は IOException を throw します。
• index が負数あるいは index + length が data のサイズを超える場合は IndexOutOfBoundsException が throw されます。
• data が null 場合は NullPointerException が throw されます。

これらの例外が throw された場合でも、そこまでに書き込んだデータは取り消されません。

パラメータ:

data - 書き込むデータを格納した byte 配列を渡します。

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

length - 書き込むバイト数を渡します。

例外:

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

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

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

writeBoolean

void writeBoolean(boolean data)
                  throws IOException

出力ストリームへ指定された booelan 値に基づいて１バイトのデータを書き込みます。 data が true の場合は 1 を、false の場合は 0 を書き込みます。 このメソッドで書き込んだデータは主に DataInput インタフェースの readBoolean メソッドによって読み出します。

パラメータ:

data - 書き込む boolean 値を渡します。

例外:

IOException - 書き込み時に何らかの障害が発生した場合に throw します。

関連項目:

DataInput.readBoolean()

writeByte

void writeByte(int data)
               throws IOException

出力ストリームへデータを 1 バイト書き込みます。 int 値として渡された data のうち、下位 8 ビットのみを書き込みます。 残りの上位 24 ビットは処理に影響を与えません。 つまり、このメソッドは write(int) メソッドと同等の処理を行います。 このメソッドで書き込んだデータは主に DataInput インタフェースの readByte メソッドによって読み出します。

パラメータ:

data - 書き込むデータを渡します。

例外:

IOException - 書き込み時に何らかの障害が発生した場合に throw します。

関連項目:

DataInput.readByte()

writeShort

void writeShort(int data)
                throws IOException

出力ストリームへ short 型の値を 2 バイトのデータとして書き込みます。 データは上位 8 ビット、下位 8 ビットの順番で書き込みます。 write(int) メソッドでデータを書き込むとすると以下の様になります。

     write((data >> 8) & 0xff);
     write(data & 0xff);

このメソッドで書き込んだデータは主に DataInput インタフェースの readShort メソッドによって読み出します。

パラメータ:

data - 書き込むデータを渡します。

例外:

IOException - 書き込み時に何らかの障害が発生した場合に throw します。

関連項目:

DataInput.readShort()

writeChar

void writeChar(int data)
               throws IOException

出力ストリームへ char 型の値を 2 バイトのデータとして書き込みます。 データは上位 8 ビット、下位 8 ビットの順番で書き込みます。 write(int) メソッドでデータを書き込むとすると以下の様になります。

     write((data >> 8) & 0xff);
     write(data & 0xff);

このメソッドで書き込んだデータは主に DataInput インタフェースの readChar メソッドによって読み出します。

パラメータ:

data - 書き込むデータを渡します。

例外:

IOException - 書き込み時に何らかの障害が発生した場合に throw します。

関連項目:

DataInput.readChar()

writeInt

void writeInt(int data)
              throws IOException

出力ストリームへ int 型の値を 4 バイトのデータとして書き込みます。 データは上位から８ビット単位に順番で書き込みます。 write(int) メソッドでデータを書き込むとすると以下の様になります。

     write((data >> 24) & 0xff);
     write((data >> 16) & 0xff);
     write((data >> 8) & 0xff);
     write(data & 0xff);

このメソッドで書き込んだデータは主に DataInput インタフェースの readInt メソッドによって読み出します。

パラメータ:

data - 書き込むデータを渡します。

例外:

IOException - 書き込み時に何らかの障害が発生した場合に throw します。

関連項目:

DataInput.readInt()

writeLong

void writeLong(long data)
               throws IOException

出力ストリームへ long 型の値を 8 バイトのデータとして書き込みます。 データは上位から８ビット単位に順番で書き込みます。 write(int) メソッドでデータを書き込むとすると以下の様になります。

     write((data >> 56) & 0xff);
     write((data >> 48) & 0xff);
     write((data >> 40) & 0xff);
     write((data >> 32) & 0xff);
     write((data >> 24) & 0xff);
     write((data >> 16) & 0xff);
     write((data >> 8) & 0xff);
     write(data & 0xff);

このメソッドで書き込んだデータは主に DataInput インタフェースの readInt メソッドによって読み出します。

パラメータ:

data - 書き込むデータを渡します。

例外:

IOException - 書き込み時に何らかの障害が発生した場合に throw します。

関連項目:

DataInput.readLong()

writeChars

void writeChars(String data)
                throws IOException

出力ストリームへ char 型配列のデータを各 char 値を順番に 2 バイトのデータとして書き込みます。 data が null の場合は NullPointerException を throw します。 data.length が 0 の場合、何もデータを書き込みません。

パラメータ:

data - 書き込む char 配列のデータを渡します。

例外:

IOException - 書き込み時に何らかの障害が発生した場合に throw します。

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

関連項目:

DataInput.readChar()

writeUTF

void writeUTF(String data)
              throws IOException

出力ストリームへ String オブジェクトが保持している文字列を Java 修正 UTF-8 形式のデータとして書き込みます。 このメソッドは以下の手順で Java 修正 UTF-8 のデータを書き込みます。

1. 出力ストリームへ文字列の長さを 2 バイトのデータとして書き込みます。長さは上位 8 ビット、下位 8 ビットの順番で書き込みます。
2. 出力ストリームへ String オブジェクトが保持する文字列を Java 修正 UTF-8 のデータとして全て書き込みます。

このメソッドで書き込んだデータは主に DataInput インタフェースの readUTF メソッドによって読み出します。

Java 修正 UTF-8 に関しては DataInput インタフェースの DataInput.readUTF() メソッドに記載されています。

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

例外:

IOException - 書き込み時に何らかの障害が発生した場合に throw します。

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

関連項目:

DataInput.readUTF()