FilterOutputStream

(KAB-studioからのおしらせです)

// Sample.java
import java.io.OutputStream;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.io.FilterOutputStream;
import java.io.IOException;

public class Sample
{
    public static void main( String[] args )
    {
        ByteArrayOutputStream byteArrayOutputStream = null;
        NormalFilterOutputStream normalFilterOutputStream = null;
        PrintStream printStream = null;
        try
        {
            // 「出力先」のByteArrayInputStreamクラスを用意します。
            byteArrayOutputStream = new ByteArrayOutputStream();

            // このクラスを対象とするNormalFilterOutputStreamクラスを用意します。
            normalFilterOutputStream = new NormalFilterOutputStream( byteArrayOutputStream );

            // このクラスを対象とするPrintStreamクラスを用意します。
            printStream = new PrintStream( normalFilterOutputStream );

            // つまり、

            // PrintStream
            // ↓
            // NormalFilterOutputStream
            // ↓
            // ByteArrayOutputStream

            // という形で、バイト出力ストリームクラスが連結したことになります。

            // 出力します。
            printStream.write( 1 );
            printStream.write( 2 );
            printStream.write( 3 );
            // NormalFilterOutputStream#write() : 1
            // NormalFilterOutputStream#write() : 2
            // NormalFilterOutputStream#write() : 3

            // 書き込まれたバイトデータをbyte型配列として取得します。
            byte[] bytes = byteArrayOutputStream.toByteArray();
            for( int iF1 = 0; iF1 < bytes.length; ++iF1 )
            {
                // 出力します。
                System.out.println( "0x" + Integer.toHexString( bytes[iF1] ) + " ( " + bytes[iF1] + " )" );
            }
            // 0x1 ( 1 )
            // 0x2 ( 2 )
            // 0x3 ( 3 )

            // このように、printStreamのwrite()メソッドを呼ぶと、
            // normalFilterOutputStreamのwrite()メソッドを呼び出し、さらに
            // byteArrayOutputStreamのwrite()メソッドを呼び出します。
            // つまりバイト出力ストリームが連結して「チェーン」になった
            // というわけです。
        }
        finally
        {
            // 処理が終わったら、最後にclose()メソッドを呼んで
            // 後処理をします。また、これは必ず行うため、
            // finally内で行います。
            if( printStream != null )
            {
                printStream.close();
            }

            // 処理が終わったら、最後にclose()メソッドを呼んで
            // 後処理をします。また、これは必ず行うため、
            // finally内で行います。
            try
            {
                if( normalFilterOutputStream != null )
                {
                    normalFilterOutputStream.close();
                }
            }
            catch( IOException e )
            {
                // close()メソッドはIOExceptionがthrows指定されているので
                // 一応受け取ります。
                e.printStackTrace();
            }

            // 処理が終わったら、最後にclose()メソッドを呼んで
            // 後処理をします。また、これは必ず行うため、
            // finally内で行います。
            try
            {
                if( byteArrayOutputStream != null )
                {
                    byteArrayOutputStream.close();
                }
            }
            catch( IOException e )
            {
                // close()メソッドはIOExceptionがthrows指定されているので
                // 一応受け取ります。
                e.printStackTrace();
            }
        }
    }
}

/**
*   NormalFilterOutputStreamクラス。
*   FilterOutputStreamクラスのサブクラスです。
*/
class NormalFilterOutputStream extends FilterOutputStream
{
    /**
    *   コンストラクタ。
    *   引数に「出力先」となるバイト出力ストリームクラスを受け取ります。
    *   「中継ぎ」に当たるので、OutputStreamクラスを引数に受け取ります。
    */
    public NormalFilterOutputStream( OutputStream out )
    {
        // 処理はスーパークラスが受け持ってくれるので、
        // スーパークラスに渡します。
        super( out );
    }

    /**
    *   write()メソッド。
    *   このクラスを利用するバイト出力ストリームクラスの
    *   write()メソッドから呼び出されます。
    */
    public void write( int b ) throws IOException
    {
        // スーパークラスであるFilterOutputStreamクラスの
        // outフィールドに「出力先」のOutputStreamクラスが
        // 入っているので、そのwrite()メソッドを呼び出します。
        out.write( b );
        System.out.println( "NormalFilterOutputStream#write() : " + b );
    }
}