モジュール java.base

パッケージ java.io

クラスOutputStream

java.lang.Object

java.io.OutputStream

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

Closeable, Flushable, AutoCloseable

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

ByteArrayOutputStream, FileOutputStream, FilterOutputStream, ObjectOutputStream, PipedOutputStream

public abstract class OutputStream extends Object implements Closeable, Flushable

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

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

導入されたバージョン:

1.0

関連項目:

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

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
OutputStream()	サブクラスが呼び出すためのコンストラクタ。

メソッドのサマリー

修飾子と型	メソッド	説明
void	close()	出力ストリームを閉じ、このストリームに関連するすべてのシステム・リソースを解放します。
void	flush()	出力ストリームをフラッシュして、バッファリングされていたすべての出力バイトを強制的に書き込みます。
static OutputStream	nullOutputStream()	すべてのバイトを破棄する新規OutputStreamを返します。
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()

サブクラスが呼び出すためのコンストラクタ。

メソッドの詳細

nullOutputStream

public static OutputStream nullOutputStream()

すべてのバイトを破棄する新規OutputStreamを返します。 返されるストリームは、最初はオープンしています。 ストリームを閉じるには、close()メソッドを呼び出します。 後からclose()をコールしても効果はありません。

ストリームがオープンしている間、write(int)、 write(byte[])およびwrite(byte[], int, int)メソッドは何も行いません。 ストリームが閉じられると、これらのメソッドはすべて IOExceptionをスローします。

flush()メソッドは何も行いません。

戻り値:

すべてのバイトを破棄するOutputStream

導入されたバージョン:

11

write

public abstract void write(int b) throws IOException

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

パラメータ:

b - byte。

例外:

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

write

public void write(byte[] b) throws IOException

指定されたバイト配列のb.lengthバイトをこの出力ストリームに書き込みます。 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]です。

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

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

APIのノート:

サブクラスでは、このメソッドをオーバーライドし、より効率的に実装してください。

実装要件:

OutputStreamのwriteメソッドは、書き込むバイトごとに1個の引数を持つ書込みメソッドを呼び出します。

パラメータ:

b - データ。

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

len - 書き込むバイト数。

例外:

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

IndexOutOfBoundsException - offが負の値の場合、lenが負の値の場合、あるいはlenがb.length - offより大きい場合

flush

public void flush() throws IOException

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

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

定義:

flush、インタフェースFlushable

実装要件:

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

例外:

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

close

public void close() throws IOException

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

定義:

close、インタフェースAutoCloseable

定義:

close、インタフェースCloseable

実装要件:

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

例外:

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