FilterInputStream

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

// Sample.java
import java.io.InputStream;
import java.io.ByteArrayInputStream;
import java.io.PushbackInputStream;
import java.io.FilterInputStream;
import java.io.IOException;

public class Sample
{
    public static void main( String[] args )
    {
        ByteArrayInputStream byteArrayInputStream = null;
        NormalFilterInputStream normalFilterInputStream = null;
        PushbackInputStream pushbackInputStream = null;
        try
        {
            // 処理対象のバイト配列1。
            byte[] bytes = new byte[]{ 1, 2, 3 };
            // そのバイト配列を読み込み対象とする
            // ByteArrayInputStreamクラス。
            byteArrayInputStream = new ByteArrayInputStream( bytes );

            // このクラスを対象とするNormalFilterInputStreamクラスを用意します。
            normalFilterInputStream = new NormalFilterInputStream( byteArrayInputStream );

            // このクラスを対象とするPushbackInputStreamクラスを用意します。
            pushbackInputStream = new PushbackInputStream( normalFilterInputStream );

            // つまり、

            // ByteArrayInputStream
            // ↓
            // NormalFilterInputStream
            // ↓
            // PushbackInputStream

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

            while( true )
            {
                // 1バイト取得します。
                int i = pushbackInputStream.read();
                if( i == -1 )
                {
                    // -1が返されてきたら終わりです。
                    break;
                }

                // 出力します。
                System.out.println( "0x" + Integer.toHexString( i ) + " ( " + i + " )" );
            }
            // NormalFilterInputStream#read() : 1
            // 0x1 ( 1 )
            // NormalFilterInputStream#read() : 2
            // 0x2 ( 2 )
            // NormalFilterInputStream#read() : 3
            // 0x3 ( 3 )
            // NormalFilterInputStream#read() : -1

            // このように、pushbackInputStreamのread()メソッドを呼ぶと、
            // normalFilterInputStreamのread()メソッドを呼び出します。
            // つまりバイト入力ストリームが連結して「チェーン」になった
            // というわけです。
        }
        catch( IOException e )
        {
            // 読み込みに失敗した際に、read()メソッドが
            // IOException例外を投げます。
            e.printStackTrace();
        }
        finally
        {
            // 処理が終わったら、最後にclose()メソッドを呼んで
            // 後処理をします。また、これは必ず行うため、
            // finally内で行います。
            try
            {
                if( pushbackInputStream != null )
                {
                    pushbackInputStream.close();
                }
            }
            catch( IOException e )
            {
                // close()メソッドはIOExceptionがthrows指定されているので
                // 一応受け取ります。
                e.printStackTrace();
            }

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

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

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

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