java.io
クラス OutputStream

java.lang.Object
  java.io.OutputStream

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

Closeable, Flushable

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

ByteArrayOutputStream, FileOutputStream, FilterOutputStream, ObjectOutputStream, OutputStream, PipedOutputStream

public abstract class OutputStream
extends Object
implements Closeable, Flushable

この抽象クラスは、バイトの出力ストリームを表現するすべてのクラスのスーパークラスです。出力ストリームは、出力バイトを受け付けて、特定の受け手に送ります。

OutputStream のサブクラスを定義する必要のあるアプリケーションでは、少なくとも 1 バイトの出力を書き込むメソッドを必ず提供しなければなりなせん。

導入されたバージョン:

JDK1.0

関連項目:

BufferedOutputStream, ByteArrayOutputStream, DataOutputStream, FilterOutputStream, InputStream, write(int)

コンストラクタの概要

OutputStream()

メソッドの概要

void	close() この出力ストリームを閉じ、このストリームに関連するすべてのシステムリソースを解放します。
void	flush() この出力ストリームをフラッシュし、バッファに入っている出力バイトをすべて強制的に書き込みます。
void	write(byte[] b) 指定されたバイト配列からこの出力ストリームに b.length バイトを書き込みます。
void	write(byte[] b, int off, int len) オフセット off から始まる指定のバイト配列からこの出力ストリームに len バイトを書き込みます。
abstract void	write(int b) この出力ストリームに指定されたバイトを書き込みます。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

OutputStream

public OutputStream()

メソッドの詳細

write

public abstract void write(int b)
                    throws IOException

この出力ストリームに指定されたバイトを書き込みます。write の汎用規約では、1 バイトが出力ストリームに書き込まれます。書き込まれるバイトは、引数 b の下位 8 ビットです。b の上位 24 ビットは無視されます。

OutputStream のサブクラスは、このメソッドの実装を提供しなければなりません。

パラメータ:

b - byte

例外:

IOException - 入出力エラーが発生した場合。特に、出力ストリームが閉じられている場合に IOException がスローされることがある

write

public void write(byte[] b)
           throws IOException

指定されたバイト配列からこの出力ストリームに b.length バイトを書き込みます。write(b) の汎用規約では、write(b) の効果は write(b, 0, b.length) を呼び出す場合とまったく同じです。

パラメータ:

b - データ

例外:

IOException - 入出力エラーが発生した場合

関連項目:

write(byte[], int, int)

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

オフセット off から始まる指定のバイト配列からこの出力ストリームに len バイトを書き込みます。write(b, off, len) の汎用規約では、配列 b 内の一定のバイトが出力ストリームに順番に書き込まれます。この処理で最初に書き込まれるバイトは要素 b[off]、最後に書き込まれるバイトは要素 b[off+len-1] です。

OutputStream の write メソッドでは、書き込むバイトごとに引数が 1 個のメソッドを呼び出します。サブクラスでは、このメソッドをオーバーライドし、より効率的に実装してください。

b が null の場合は、NullPointerException がスローされます。

off が負の場合、len が負の場合、あるいは off+len が配列 b の長さより大きい場合は、IndexOutOfBoundsException がスローされます。

パラメータ:

b - データ

off - データの開始オフセット

len - 書き込むバイト数

例外:

IOException - 入出力エラーが発生した場合。特に、出力ストリームが閉じられている場合に IOException がスローされる

flush

public void flush()
           throws IOException

この出力ストリームをフラッシュし、バッファに入っている出力バイトをすべて強制的に書き込みます。flush の汎用規約では、それまでに書き込まれたバイトが出力ストリームの実装によってバッファに入れられている場合に flush を呼び出すと、それらのバイトはただちにその目的の転送先に書き込まれます。

このストリームの目的の送信先が、基本となるオペレーティングシステムによって提供される抽象化オブジェクトである場合 (ファイルなど)、ストリームをフラッシュすると、ストリームに直前に書き込まれたバイトのみがオペレーティングシステムに引き渡され、書き込まれます。ディスクドライブなどの物理デバイスに実際に書き込まれるとは限りません。

OutputStream の flush メソッドは何も行いません。

定義:

インタフェース Flushable 内の flush

例外:

IOException - 入出力エラーが発生した場合

close

public void close()
           throws IOException

この出力ストリームを閉じ、このストリームに関連するすべてのシステムリソースを解放します。close の汎用規約では、close は出力ストリームを閉じます。閉じられたストリームは出力処理を実行できません。また、それを開き直すことはできません。

OutputStream の close メソッドは何も行いません。

定義:

インタフェース Closeable 内の close

例外:

IOException - 入出力エラーが発生した場合