モジュール java.base
パッケージ 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をこの出力ストリームに書き込みます。

    • フィールドの詳細

      • 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を指定して呼び出します。

        このメソッドは、単一の引数bを使用して、基本となる出力ストリームの1引数のwriteメソッドを呼び出さないことに注意してください。

        オーバーライド:
        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、インタフェース: AutoCloseable
        定義:
        close、インタフェース: Closeable
        オーバーライド:
        close、クラス: OutputStream
        例外:
        IOException - 入出力エラーが発生した場合。
        関連項目:
        flush(), out