apt(1)

名前
apt - 注釈処理ツール

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

機能説明
注釈処理ツール apt には、プログラム注釈を処理するための一連の 新しいリフレクション API とインフラストラクチャサポートが含まれています。 apt のリフレクション API では、プログラム構造のビューが、 ビルド時のソースベースの読み取り専用として用意されています。 これらのリフレクション API は、総称型の追加後に、 Java(TM) プログラミング言語の型システムを わかりやすくモデル化できるように設計されました。 はじめに、 apt は注釈プロセッサを実行します。この注釈プロセッサでは、 新規のソースコードおよびその他のファイルを生成します。 次に、オリジナルのソースファイルと生成したソースファイルの両方をコンパイルし、 開発を容易にします。ツールと対話するためのリフレクション API と その他の API は、 com.sun.mirror のサブパッケージです。

apt によるツールの操作方法と開発手順についての詳細は、 http://java.sun.com/j2se/1.5.0/docs/guide/apt/GettingStarted.html の「Getting Started with apt」を参照してください。

パラメータ
オプションは任意の順序で使用できます。特定のオプションに適用される パラメータについては、後述の「オプション」を参照してください。

sourcefiles
    処理される 0 個以上のソースファイル。

@files
    ソースファイルまたはその他のオプションをリストする 1 個以上のファイル。

オプション

  apt 固有のオプション

-s dir
    プロセッサが生成するソースファイルが配置されるディレクトリルートを 指定します。ファイルはパッケージのネームスペースに従って、 サブディレクトリに配置されます。

-nocompile
    ソースファイルをクラスファイルにコンパイルしません。

-print
    指定した型のテキスト表現を出力します。 注釈処理やコンパイルは実行しません。

-A[key[=val]]
    注釈プロセッサに渡されるオプション。 apt は、これらのオプションを直接解釈しませんが、個別のプロセッサ によって使用可能になります。

-factorypath path
    注釈プロセッサファクトリを検索する場所を指定します。 このオプションを使用する場合、ファクトリの検索に クラスパスは使用されません。

-factory classname
    使用する注釈プロセッサファクトリの名前。 デフォルトの検出処理はバイパスされます。

  javac と共有されるオプション

-d dir
    プロセッサおよび javac が生成したクラスファイルを配置する場所を指定します。

-cp path または-classpath path
    ユーザクラスファイルおよび注釈プロセッサファクトリを検索する場所を 指定します。 -factorypath を指定した場合、ファクトリの検索にクラスパスは使用されません。

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

注意事項
apt ツールおよび関連する API は、将来の J2SE リリースで 変更または廃止される場合があります。

関連項目
javac(1), java(1)