apt(1)

名前

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ツールと、パッケージcom.sun.mirrorに含まれているそれに関連したAPIは、JDK 7以降非推奨になっており、JDKの次のメジャー・リリースで削除される予定です。javac(1)ツールで利用可能なオプションと、パッケージjavax.annotation.processingおよびjavax.lang.modelに含まれているAPIを使用して、注釈を処理してください。

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

ツールの機能に関する詳細およびaptを使用した開発手順は、 aptスタート・ガイド @
http://docs.oracle.com/javase/7/docs/technotes/guides/apt/GettingStarted.htmlを参照してください。

オプション

  apt固有のオプション

    -s dir
        プロセッサの生成するソース・ファイルを置くディレクトリ・ルートを指定します。ファイルは、パッケージの名前空間に基づいてサブディレクトリに置かれます。

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

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

    -A[key[=val]]
        注釈プロセッサへ渡すオプションです。このオプションは、aptが直接解釈するのではなく、それぞれのプロセッサで使用できるようになります。

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

    -factory classname
        使用する注釈プロセッサ・ファクトリの名前です。デフォルトの検出プロセスを省略します。

    -version
        バージョン情報を出力します。

    -X  非標準オプションに関する情報を表示します。

  javacと共用するオプション

    -d dir
        プロセッサとjavac生成のクラス・ファイルを置く場所を指定します。

    -cppathまたは-classpathpath
        ユーザー・クラス・ファイルと注釈プロセッサ・ファクトリを検索する場所を指定します。-factorypathが指定されている場合、クラス・パスのファクトリは検索されません。

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

  非標準オプション

    -XListAnnotationTypes
        検出された注釈の型をリストします。

    -XListDeclarations
        指定およびインクルードされる宣言をリストします。

    -XPrintAptRounds
        初期および再帰的なaptラウンドに関する情報を出力します。

    -XPrintFactoryInfo
        ファクトリに処理をリクエストする注釈に関する情報を出力します。

    -XclassesAsDecls
        クラス・ファイルとソース・ファイルの両方を、処理対象の宣言として処理します。

注意: これらは非標準オプションなので、予告なく変更される可能性があります。

注意

aptツールと、パッケージcom.sun.mirrorに含まれているそれに関連したAPIは、JDK 7以降非推奨になっており、JDKの次のメジャー・リリースで削除される予定です。javac(1)ツールで利用可能なオプションと、パッケージjavax.annotation.processingおよびjavax.lang.modelに含まれているAPIを使用して、注釈を処理してください。

関連項目

    o   javac(1)、java(1)