apt(1)

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 ツールと、パッケージ 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://java.sun.com/javase/6/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 生成のクラスファイルを置く場所を指定します。

    -cp path または -classpath path
        ユーザークラスファイルと注釈プロセッサファクトリを検索する場所を指定します。-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)