java.io

クラス FilterOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

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

Closeable, Flushable, AutoCloseable

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

BufferedOutputStream, CheckedOutputStream, CipherOutputStream, DataOutputStream, DeflaterOutputStream, DigestOutputStream, InflaterOutputStream, PrintStream

public class FilterOutputStream
extends OutputStream

このクラスは、出力ストリームをフィルタ処理するすべてのクラスのスーパークラスです。これらのストリームは、データの基本のシンクとして使用するための既存の出力ストリーム (ベースとなる出力ストリーム) の最上位にあります。ただし、データを途中で変換することや、追加機能を提供することもあります。

FilterOutputStream クラスそのものが、ベースとなる出力ストリームにすべての要求を渡すバージョンによって、OutputStream のすべてのメソッドを単純にオーバーライドします。FilterOutputStream のサブクラスは、これらのメソッドの一部をさらにオーバーライドすることができ、追加のメソッドやフィールドを提供することもできます。

導入されたバージョン:

JDK1.0

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected OutputStream	out フィルタ処理されるベースとなる出力ストリームです。

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

コンストラクタ

コンストラクタと説明
FilterOutputStream(OutputStream out) 指定されたベースとなる出力ストリームの上位に出力ストリームフィルタを作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	close() 出力ストリームを閉じ、これに関連するすべてのシステムリソースを解放します。
void	flush() 出力ストリームをフラッシュして、バッファリングされていたすべての出力バイトを強制的にストリームに書き込みます。
void	write(byte[] b) b.length バイトのデータをこの出力ストリームに書き込みます。
void	write(byte[] b, int off, int len) 指定された byte 配列のオフセット位置 off から始まる len バイトをこの出力ストリームに書き込みます。
void	write(int b) 指定された byte をこの出力ストリームに書き込みます。

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

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

フィールドの詳細

out

protected OutputStream out

フィルタ処理されるベースとなる出力ストリームです。

コンストラクタの詳細

FilterOutputStream

public FilterOutputStream(OutputStream out)

指定されたベースとなる出力ストリームの上位に出力ストリームフィルタを作成します。

パラメータ:

out - あとで使用できるように this.out フィールドに割り当てられるベースとなる出力ストリーム。このインスタンスがベースとなるストリームなしに生成される場合は null。

メソッドの詳細

write

public void write(int b)
           throws IOException

指定された byte をこの出力ストリームに書き込みます。

FilterOutputStream の write メソッドは、ベースとなる出力ストリームの write メソッドを呼び出します。つまり、out.write(b) を実行します。

OutputStream の抽象 write メソッドを実装します。

定義:

write、クラス: OutputStream

パラメータ:

b - byte。

例外:

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

write

public void write(byte[] b)
           throws IOException

b.length バイトのデータをこの出力ストリームに書き込みます。

FilterOutputStream の write メソッドは、3 つの引数をとる write メソッドに引数 b、0、および b.length を指定して呼び出します。

このメソッドは、そのベースとなるストリームの 1 つの引数をとる write メソッドに 1 つの引数 b を指定して呼び出すのではないことに注意してください。

オーバーライド:

write、クラス: OutputStream

パラメータ:

b - 書き込まれるデータ。

例外:

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

関連項目:

write(byte[], int, int)

write

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

指定された byte 配列のオフセット位置 off から始まる len バイトをこの出力ストリームに書き込みます。

FilterOutputStream の write は、出力する各 byte に対して、1 つの引数をとる write メソッドを呼び出します。

このメソッドは、ベースとなる入力ストリームの write メソッドを同じ引数で呼び出すのではないことに注意してください。FilterOutputStream のサブクラスでは、このメソッドをより効率的に実装してください。

オーバーライド:

write、クラス: OutputStream

パラメータ:

b - データ。

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

len - 書き込むバイト数。

例外:

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

関連項目:

write(int)

flush

public void flush()
           throws IOException

出力ストリームをフラッシュして、バッファリングされていたすべての出力バイトを強制的にストリームに書き込みます。

FilterOutputStream の flush メソッドはそのベースとなる出力ストリームの flush メソッドを呼び出します。

定義:

flush、インタフェース: Flushable

オーバーライド:

flush、クラス: OutputStream

例外:

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

関連項目:

out

close

public void close()
           throws IOException

出力ストリームを閉じ、これに関連するすべてのシステムリソースを解放します。

FilterOutputStream の close メソッドは、flush メソッドを呼び出してから、そのベースとなる出力ストリームの close メソッドを呼び出します。

定義:

close、インタフェース: Closeable

定義:

close、インタフェース: AutoCloseable

オーバーライド:

close、クラス: OutputStream

例外:

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

関連項目:

flush(), out