java.io
クラス FilterOutputStream

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--java.io.FilterOutputStream

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

BufferedOutputStream, CheckedOutputStream, CipherOutputStream, DataOutputStream, DeflaterOutputStream, DigestOutputStream, 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 の abstract write メソッドを実装します。

定義:

クラス OutputStream 内の write

パラメータ:

b - byte

例外:

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

write

public void write(byte[] b)
           throws IOException

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

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

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

オーバーライド:

クラス OutputStream 内の write

パラメータ:

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 のサブクラスは、このメソッドのより効率の良い実装を提供するようにした方がよいでしょう。

オーバーライド:

クラス OutputStream 内の write

パラメータ:

b - データ

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

len - 書き込むバイト数

例外:

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

関連項目:

write(int)

flush

public void flush()
           throws IOException

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

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

オーバーライド:

クラス OutputStream 内の flush

例外:

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

関連項目:

out

close

public void close()
           throws IOException

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

FilterOutputStream の close メソッドはまず、その flush メソッドを呼び出し、次に基本となる出力ストリームの close メソッドを呼び出します。

オーバーライド:

クラス OutputStream 内の close

例外:

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

関連項目:

flush(), out