switch ステートメントの完全性を確保する

それぞれの switch ステートメントが、各実行の実行時に適切なブランチを検出するという意味において完全であることを確認するよう推奨されています。 以下のすべてを考慮に入れた場合、実際のところ、これは容易な作業ではありません。

また、JLS では列挙型 switch ステートメント (予期しないコンパイル時エラーが発生する可能性があります) に関してフロー分析が求められます。

    enum Colors { RED, GREEN, BLUE }
    String colorString(Color c) {
        switch(c) {
            case RED: return "red";
            case GREEN: return "green";
            case BLUE: return "blue";
        }
    }

コンパイラーは、次のように応答します。

『このメソッドは型 String の結果を必ず戻す必要があります。 switch での default: 欠落がこの問題に関連していると思われますが、それに関する問題は抑止されています』。

このメッセージは、完全性に関する別の通知内容をユーザーにアラートすることを目的としたものです。 つまり、JLS によって求められているフロー分析によって、default ケースが欠落しているそれぞれの 列挙型 switch ステートメントは、現時点で既知のすべての列挙型定数をリストしている場合であっても不完全であると見なされます。 この問題には return ステートメントや、ローカル変数における代入が限定的になったり、最終フィールドがブランクになったりすることが関係します。 ただし、以下の推奨すべてに従うと、前述のエラー・メッセージはまったく表示されなくなります。

各種レベルにおける不完全性のレポート作成用の構成オプションのそれぞれについては、コンパイラー設定を参照してください。後ほど、別の設計目標とポリシー、および Eclipse Java コンパイラーを使用したその確認方法を取り上げます。

「default:」の使用

各 switch ステートメントに意味ある default ブランチが存在するのが理想的です。そうしたブランチでは、明示的にはリストされていないものの『すべての場合に妥当』な戦略を使用してすべてのケースを処理します。 もちろんそうした戦略は見い出すのは困難で多くの場合には不可能でさえありますが、意味ある default を実装することができれば、それは確かに最善のソリューションです。

推奨: default ケースが欠落しているそれぞれの switch ステートメントについてコンパイラーが警告するように設定し、すべての switch ステートメントに対して default の適切な実装を探求することを思い起こすことができるようにしてください。

コンパイラーが default ケースの欠落について警告するものの、default では何もしないのが妥当という場合には、そのこともドキュメントに明記するとよいでしょう。

推奨:「何もしない」ことが妥当な default 戦略の場合、対象の switch で何もしないのが適切であること (およびその理由) を記したコメントだけをアクションとする default: ラベルを追加してください。 そのようにすることにより、コンパイラーに対し、default ケースを単に忘れた わけではないことを通知できます。

妥当な default 実装がどうしても見つからない場合、最終手段として、ダウンストリームにおいて他のエラーの根本原因となるような予期しない値を回避するのがよいでしょう。 つまり実行時に早めにエラーとして処理するということです。

推奨: 妥当な default 実装を見つけることもできず、「何もしない」ことが適切な戦略でもない場合には、例外をスローしたり、問題をログに記録したり、またはその両方を行う default: ケースを追加します。

それぞれの switch ステートメントは、上記の 3 つのカテゴリーのいずれかに当てはまらなければなりません。 つまり、コンパイラーが default ケースが欠落しているそれぞれの場合についてユーザーに警告を出すというのが普遍的に有効な戦略だと言えます。

すべての列挙型定数の処理

列挙型値に関して switch を実行する場合、それぞれの列挙型定数を、対応する case ステートメントで明示的に扱うのが望ましいことがあります。

推奨: 任意の列挙型定数に関して case ステートメントが欠落している各 switch ステートメントについて警告を出す場合、 「'default' ケースが存在する場合でもシグナル」オプションを有効にすることを考慮してください。

すべての 列挙型 switch ですべての列挙型定数に言及するオプションは望ましくないが、一部 の列挙型 switch ステートメントに関しては case ラベルが欠落している場合に警告を出すようにする場合は、それぞれの列挙型 switch ステートメントで個別に戦略を選択する必要があります。

推奨: 一部の switch ステートメントでは前述の警告が適している場合には、グローバルに警告を有効にし、一部の列挙型定数に関して case を省略 しても問題がない switch ステートメントを識別します。 そうしたステートメントは default ケースで処理するのが適切だからです。 そのような switch ステートメントの場合、「//$CASES-OMITTED$」タグ・コメントを使用して、決定内容をドキュメントとして明記します。
    String colorString2(Color c) {
        switch(c) {
        case RED: return "red";
        case GREEN: return "green";
            //$CASES-OMITTED$
            default:
        	return "unknown color";
        }
    }

ヒント: コンパイラーが「Color についてのこの列挙型 switch には、列挙型定数 BLUE に対応する case ラベルがなければなりません」などとレポートする場合、タグ・コメントを挿入するためにクイック・フィックスが表示されます。

要約

前述の考慮事項では、不完全な switch ステートメントについてすべてのオプションの警告を有効にしているとコンパイラーの機能を最大限に利用できること、また、ドキュメントが空の default ケースに //$CASES-OMITTED$ タグ・コメントを追加して使用することにより、設計上、不完全であっても問題ない switch ステートメントにマークを付けられることを考慮しました。 こうした推奨に従うと、後になって 1 つ以上の列挙型定数を追加するという状況を含め、ブランチが間違って省略されると、すべての関連する警告 (または望む場合にはエラーも) が表示されます。 そのようにすれば、網羅が最大限に確保された上で、例外があればすべてコード中にドキュメントとして明示され、警告によってフラグが立てられないようになります。

コンパイラーは実行時に不整合なクラス・バージョンの使用を回避できないのでクラスが古いバージョンの列挙型に対してコンパイルされる場合がありますが、実行アプリケーションでは複数の列挙型定数が存在する可能性があります。 こうした状況あるいは同様の状況では、適切な「catch-all」default を実装すると、この不整合についてアラートする実行時例外が生じ、そのエラーがアプリケーション内でさらに伝搬するという事態を避けられます。

前述の推奨されている文法に厳格に従うコンパイラー設定の値を追加すると、return ステートメントが欠落していることに関する前述の不確かなエラー・メッセージ (または初期化されていない変数に関する同様のメッセージ) は表示されなくなります。