概要 (ミラー API)

パッケージ
パッケージ	説明
com.sun.mirror.apt	注釈プロセッサと注釈処理ツール間で情報をやり取りするために使用されるクラス。
com.sun.mirror.declaration	プログラム要素の宣言をモデル化するために使用されるインタフェース。
com.sun.mirror.type	型をモデル化するために使用されるインタフェース。
com.sun.mirror.util	宣言と型の処理に役立つユーティリティーです。

ミラー API は、プログラムのセマンティク構造をモデル化するために使用されます。これは、クラス、メソッド、フィールドなどの、プログラムで宣言されたエンティティーの表現を提供します。個々の文や式などの、メソッドレベルより下の構造は表されません。

また、プログラム要素の注釈を検査したり、処理したりするために注釈プロセッサを記述するためのサポートも含まれています。たとえば、注釈プロセッサを使用すると、元のコードと組み合わせて使用される新しいソースファイルや XML ドキュメントを作成できます。

API の特性

プログラムは、仮想マシンのレベルではなく、言語レベルで表されます。たとえば、ネストされたクラスは、VM によって認識される変換された形式ではなく、最上級の構造として処理されます。ソースコードとコンパイルされたコード (クラスファイル) の両方をこの方法でモデル化できます。

プログラムは、その静的な (つまり、ビルド時の) 形式でモデル化されます。これは、クラスやオブジェクトに関する実行時の情報を提供するリフレクション API とは異なります。

この API では、新しいコードを生成するための直接のサポートは提供されません。

宣言と型

ミラー API は、主に Declaration インタフェースと com.sun.mirror.declaration パッケージ内のサブインタフェースの階層を通してプログラム構造を表します。Declaration は、パッケージ、クラス、メソッドなどのプログラム要素を表します。インタフェースの階層をここに示します。

型は、TypeMirror インタフェースと com.sun.mirror.type パッケージ内のそのサブインタフェースの階層によって表されます。型には、プリミティブ型、クラス型とインタフェース型、配列型、型変数、およびワイルドカードがあります。インタフェースの階層をここに示します。

この API では、宣言と型が明確に区別されます。これは、1 つの宣言で無限の型ファミリを定義できる、ジェネリック型にとってもっとも重要です。たとえば、java.util.Set の宣言によって、raw 型 java.util.Set、パラメータ化された型 java.util.Set<String>、およびその他の多くの型が定義されます。注釈を付けることができるのは宣言だけであり、たとえば、メソッドシグニチャーに含めることができるのは型だけです。

モデル化されているプログラムは、不明なクラスやインタフェース型に依存する可能性があるという点で、不完全である可能性があります。これは、クラスファイルの不足などのエラー処理の結果であるか、注釈プロセッサが見つからない型を作成しようとしている可能性があります。このような不明な型の処理方法については、DeclaredType を参照してください。

ユーティリティーとツールのサポート

com.sun.mirror.util パッケージは、宣言や型の処理を支援するためのユーティリティーを提供します。宣言や型のオブジェクトを操作するときにビジターデザインパターンを使用するためのサポートが含まれています。

com.sun.mirror.apt パッケージは、注釈プロセッサの記述をサポートします。これにより、注釈プロセッサが注釈処理ツールと対話するためのメカニズムが提供されます。