NAME

apt - 注釈処理ツール

形式

apt [-classpath classpath] [-sourcepath sourcepath] [-d directory] [-s directory] [-factorypath path] [-factory class] [-print] [-nocompile] [-Akey[=val] ...][javac option] sourcefiles [@files]

パラメータ

オプションは順不同です。特定のオプションに適用されるパラメータについては、下記の「オプション」を参照してください。

sourcefiles
ゼロ、1 つ、または複数の処理対象のソースファイル
@files
ソースファイルまたは他のオプションを一覧表示する 1 つまたは複数のファイル

説明

注釈処理ツール apt は、新しいリフレクト API とサポートインフラストラクチャーから構成され、プログラム注釈を処理します。apt リフレクト API は、 構築時のソースベースで、プログラム構造に関する読み取り専用ビューを提供します。これらのリフレクト API は、総称を追加した後に、JavaTM プログラミング言語の型システムを正しくモデル化するように設計されています。最初に、apt は、新しいソースコードと他のファイルを作成する注釈プロセッサを実行します。次に、apt は、元のソースファイルと生成したソースファイルの両方をコンパイルするため、開発が楽になります。ツールとのインタフェースに使用されるリフレクト API などの API は、com.sun.mirror のサブパッケージです。

ツールの機能に関する詳細と、apt を使用した開発方法については、apt 入門」を参照してください。

注:
apt の機能は、javac ツールの一部となった注釈処理インフラストラクチャーに組み込まれ、すべての Java コンパイラで使用できるように標準化されました。この新しいインフラストラクチャーは、言語モデルおよび Java プラットフォームの一部となった注釈処理 API に依存します。注釈プロセッサの開発は、新しい API および javac ツールに基づいて行うようお勧めします。

オプション

apt 固有のオプション

-s dir
プロセッサの生成するソースファイルを置くディレクトリルートを指定します。 ファイルは、パッケージの名前空間に基づいてサブディレクトリに置かれます。
-nocompile
ソースファイルをクラスファイルにコンパイルしません。
-print
指定したタイプのテキスト表現を出力します。 注釈処理またはコンパイルは行いません。
-A[key[=val]]
注釈プロセッサへ渡すオプションです。 このオプションは、apt が直接解釈するのではなく、それぞれのプロセッサによって使用できるように変えられます。
-factorypath path
注釈プロセッサファクトリを検索する場所を指定します。 このオプションを使用する場合、クラスパスのファクトリは検索されません。
-factory classname
使用する注釈プロセッサファクトリの名前です。 デフォルトの検出プロセスを省略します。

javac と共用するオプション

-d dir
プロセッサと javac 生成のクラスファイルを置く場所を指定します。
-cp path or -classpath path
ユーザークラスファイルと注釈プロセッサファクトリを検索する場所を指定します。-factorypath が指定されている場合、クラスパスのファクトリは検索されません。

javac オプションの詳細については、javac(1) のマニュアルページを参照してください。

apt の機能は、javac により提供される標準注釈処理インフラストラクチャーに組み込まれました。今後の JDK リリースでは、apt および関連する API のサポートが中止する可能性があります。

関連項目