java.io
クラス OutputStream

java.lang.Object
  java.io.OutputStream

直系の既知のサブクラス:

ByteArrayOutputStream, DataOutputStream, PrintStream

public abstract class OutputStream
extends Object

バイト単位で連続的な出力を行う「出力ストリーム」処理を行うすべてのクラスのスーパークラスです。 このクラスは抽象クラスとして宣言されており、write(int) メソッドをサブクラスで実装する必要があります。

関連項目:

InputStream

OutputStream

public OutputStream()

デフォルトのコンストラクタです。

write

public abstract void write(int data)
                    throws IOException

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

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

サブクラスではこの規約に従ってこのメソッドを実装しなければなりません。

パラメータ:

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

例外:

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

write

public void write(byte[] data)
           throws IOException

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

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

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

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

OutputStream クラスにおけるこのメソッドは、write(data, 0, data.length) と記述するのと等価です。

パラメータ:

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

例外:

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

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

write

public 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 された場合でも、そこまでに書き込んだデータは取り消されません。

OutputStream クラスにおけるこのメソッドは、write(int) メソッドを必要回数呼び出してデータを書き込むように記述されています。

サブクラスでより効率的な処理が可能な場合はオーバーライドして処理を記述すべきです。

パラメータ:

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

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

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

例外:

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

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

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

flush

public void flush()
           throws IOException

出力ストリームがバッファリングを行っている場合、そのバッファに格納されているデータを直ちに書き込み先に出力します。 サブクラスでバッファリングを伴う実装を行う場合はこのメソッドを適切に実装しなければなりません。

OutputStream クラスにおけるこのメソッドは何も処理を行いません。

例外:

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

close

public void close()
           throws IOException

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

OutputStream クラスにおけるこのメソッドは何も処理を行いません。

例外:

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