アサーション

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

// Sample.java
public class Sample
{
    public static void main( String[] args )
    {
        // 注：
        // アサーションはJ2SEのバージョンが1.4以降である必要があります。
        // また、実行時にVM引数に-eaを追加しなければアサーションは機能しません。
        // Eclipseの場合、メニューの「実行」-「デバッグ」の
        // 「起動構成の作成、管理、及び実行」ダイアログの「引き数」ページの
        // 「VM 引き数」に-eaを追記してください。

        // 一番標準的なアサーションの使用方法。
        // addOne()メソッドは「引数にnullを渡してはいけない」という
        // 仕様になっています。
        // そのため、本来であれば、下記のstringは、nullチェックを
        // 行い、nullでない場合にのみaddOne()メソッドに渡すようにします。
        // assertは、そういう「関数の呼び出し元に、関数のルール（契約による設計）
        // を守らせる」ために存在します。
        String string = "テスト";

        if( string != null )
        {
            String result = addOne( string );
            System.out.println( result );
            // テスト1
        }

        // assertが「契約を守らせるためにある」ため、assertから
        // 投げられるAssertionErrorクラスを拾ってはいけません。
        // プログラムは、必ず「assertが発生しないよう」に作る
        // 必要があります。
    }

    /**
    *   assertの一番基本的な使い方。
    *   @param string 出力する文字列。nullは不可。
    *   @return 引数に"1"を足したものを返します。nullは返しません。
    */
    private static String addOne( String string )
    {
        // assertで、引数をチェックします。
        assert string != null : "引数stringがnullです。";
        // このように「本来はあってはいけない値」をチェックする
        // ために使用します。

        // 引数に"1"をくっつけます。
        String result = string + "1";
        // assertでチェックします。
        assert result != null : "戻り値がnullです。";
        // 自分で実装するのになんでこれが必要なの？　と思うかも
        // しれませんが、このようにすることで、自分の実装ミスを
        // 回避することができるからです。つまり、このように
        // プログラムで記述することで、自分のミスを防ぐわけです。

        return result;
    }
}