クラス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のサブクラスは、これらのメソッドの一部をさらにオーバーライドすることができ、追加のメソッドやフィールドを提供することもできます。

導入されたバージョン:
1.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をこの出力ストリームに書き込みます。

    クラスで宣言されたメソッド OutputStream

    nullOutputStream
    修飾子と型
    メソッド
    説明
    static OutputStream
    nullOutputStream()
    すべてのバイトを破棄する新規OutputStreamを返します。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • フィールド詳細

    • 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バイトのデータをこの出力ストリームに書き込みます。
      オーバーライド:
      write、クラスOutputStream
      実装要件:
      FilterOutputStreamのwriteメソッドは、3つの引数をとるwriteメソッドに引数b、0、およびb.lengthを指定して呼び出します。
      実装上のノート:
      このメソッドは、単一の引数bを使用して、基本となる出力ストリームの1引数のwriteメソッドを呼び出さないことに注意してください。
      パラメータ:
      b - 書き込まれるデータ。
      スロー:
      IOException - 入出力エラーが発生した場合。
      関連項目:

    • write

      public void write(byte[] b, int off, int len) throws IOException
      指定されたbyte配列のオフセット位置offから始まるlenバイトをこの出力ストリームに書き込みます。
      オーバーライド:
      write、クラスOutputStream
      実装要件:
      FilterOutputStreamのwriteは、出力する各byteに対して、1つの引数をとるwriteメソッドを呼び出します。
      実装上のノート:
      このメソッドは、基礎となる出力ストリームのwriteメソッドを同じ引数でコールしません。 FilterOutputStreamのサブクラスでは、このメソッドをより効率的に実装してください。
      パラメータ:
      b - データ。
      off - データの開始オフセット。
      len - 書き込むバイト数。
      スロー:
      IOException - 入出力エラーが発生した場合。
      IndexOutOfBoundsException - offが負の値の場合、lenが負の値の場合、あるいはlenがb.length - offより大きい場合
      関連項目:

    • flush

      public void flush() throws IOException
      出力ストリームをフラッシュして、バッファリングされていたすべての出力バイトを強制的にストリームに書き込みます。
      定義:
      flush、インタフェースFlushable
      オーバーライド:
      flush、クラスOutputStream
      実装要件:
      FilterOutputStreamのflushメソッドはそのベースとなる出力ストリームのflushメソッドを呼び出します。
      スロー:
      IOException - 入出力エラーが発生した場合。
      関連項目:

    • close

      public void close() throws IOException
      出力ストリームを閉じ、これに関連するすべてのシステム・リソースを解放します。
      定義:
      close、インタフェースAutoCloseable
      定義:
      close、インタフェースCloseable
      オーバーライド:
      close、クラスOutputStream
      実装要件:
      まだ閉じていない場合、 FilterOutputStreamのcloseメソッドは、そのflushメソッドをコールし、その基礎となる出力ストリームのcloseメソッドをコールします。
      スロー:
      IOException - 入出力エラーが発生した場合。
      関連項目: