apt.1 revision 4176
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." This code is free software; you can redistribute it and/or modify it
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." under the terms of the GNU General Public License version 2 only, as
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." published by the Free Software Foundation.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." This code is distributed in the hope that it will be useful, but WITHOUT
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." version 2 for more details (a copy is included in the LICENSE file that
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." accompanied this code).
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." You should have received a copy of the GNU General Public License version
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." 2 along with this work; if not, write to the Free Software Foundation,
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering." or visit www.oracle.com if you need additional information or have any
07630cea1f3a845c09309f197ac7c4f11edd3b62Lennart Poettering.TH apt 1 "10 May 2011"
0d39fa9c69b97a2ceb156053deef69c0866c2b97Lennart Poettering\f2apt\fP \- annotation processing tool
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering\f2apt [\-classpath \fP\f2classpath\fP] [\-sourcepath \f2sourcepath\fP] [\-d \f2directory\fP] [\-s \f2directory\fP] [\-factorypath \f2path\fP] [\-factory \f2class\fP] [\-print] [\-nocompile] [\-A\f2key\fP[\f2=val\fP] ...] [\f2javac option\fP] sourcefiles [@files]
6bedfcbb2970e06a4d3280c8fb62083d252ede73Lennart Poettering.SH "PARAMETERS"
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringOptions may be in any order. For a discussion of parameters which apply to a specific option, see OPTIONS below.
07630cea1f3a845c09309f197ac7c4f11edd3b62Lennart PoetteringZero or more source files to be processed.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringOne or more files that list source files or other options
6db615c17ee7a434f9e0c40d67a1f833d8f3cc9dLennart Poettering.SH "DESCRIPTION"
9f103625b145a397e67c3714766775b615c8b587Tobias Hunger\f3Note\fP: The \f2apt\fP tool and its associated API contained in the package \f2com.sun.mirror\fP have been deprecated since JDK 7 and are planned to be removed in the next major JDK release. Use the options available in the \f2javac(1)\fP tool and the APIs contained in the packages \f2javax.annotation.processing\fP and \f2javax.lang.model\fP to process annotations.
5607d856b8606ba75446a07ab5e9048753e1d7a6Zbigniew Jędrzejewski-SzmekThe tool \f2apt\fP, annotation processing tool, includes reflective APIs and supporting infrastructure to process program annotations. The \f2apt\fP reflective APIs provide a build\-time, source\-based, read\-only view of program structure. These reflective APIs are designed to cleanly model the Java(TM) programming language's type system after the addition of generics. First, \f2apt\fP runs annotation processors that can produce new source code and other files. Next, \f2apt\fP can cause compilation of both original and generated source files, easing development. The reflective APIs and other APIs used to interact with the tool are subpackages of \f2com.sun.mirror\fP.
5607d856b8606ba75446a07ab5e9048753e1d7a6Zbigniew Jędrzejewski-SzmekA fuller discussion of how the tool operates as well as instructions for developing with \f2apt\fP are in
5607d856b8606ba75446a07ab5e9048753e1d7a6Zbigniew Jędrzejewski-Szmek\f4Getting Started with \fP\f4apt\fP. @
7fd1b19bc9e9f5574f2877936b8ac267c7706947Harald Hoyerhttp://download.oracle.com/javase/7/docs/technotes/guides/apt/GettingStarted.html
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poetteringapt specific options
00b4ffdecbb39d849af65c0ab741be482325a4a9Lennart PoetteringSpecify the directory root under which processor\-generated source files will be placed; files are placed in subdirectories based on package namespace.
689aede8c622ba68d9060e4edee27364445b2007Lennart PoetteringDo not compile source files to class files.
7410616cd9dbbec97cf98d75324da5cda2b2f7a2Lennart PoetteringPrint out textual representation of specified types; perform no annotation processing or compilation.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringOptions to pass to annotation processors \-\- these are not interpreted by \f2apt\fP directly, but are made available for use by individual processors
d0aa9ce51915f6f7448adfeb4be0f46cc1356124Zbigniew Jędrzejewski-Szmek\-factorypath path
d0aa9ce51915f6f7448adfeb4be0f46cc1356124Zbigniew Jędrzejewski-SzmekSpecify where to find annotation processor factories; if this option is used, the classpath is \f2not\fP searched for factories.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering\-factory classname
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringName of annotation processor factory to use; bypasses default discovery process
67ab5f761f9b854d8ce85f9ee47b298e497f8bd9Tom GundersenPrint version information.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringDisplay information about non\-standard options.
c3834f9b881f2b1a68dc7d797c134f0b66b47b57Lennart PoetteringOptions shared with javac
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringSpecify where to place processor and javac generated class files
bf1d7ba70aceddb5dae0cd2e370b8afaf0c81b05Karel Zak\-cp path or \-classpath path
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringSpecify where to find user class files and annotation processor factories. If \f2\-factorypath\fP is given, the classpath is not searched for factories.
b3208b662948b51ff34e7b7752e28ec7a48708aeZbigniew Jędrzejewski-SzmekConsult the javac(1) man page for information on \f2javac\fP options.
b3208b662948b51ff34e7b7752e28ec7a48708aeZbigniew Jędrzejewski-SzmekNon\-Standard Options
5607d856b8606ba75446a07ab5e9048753e1d7a6Zbigniew Jędrzejewski-Szmek\-XListAnnotationTypes
4e82fe5213bedcb70e25c0270e516d5f2706d8c8Tom GundersenList found annotation types.
4e82fe5213bedcb70e25c0270e516d5f2706d8c8Tom Gundersen\-XListDeclarations
4e82fe5213bedcb70e25c0270e516d5f2706d8c8Tom GundersenList specified and included declarations.
4a62c710b62a5a3c7a8a278b810b9d5b5a0c8f4fMichal Schmidt\-XPrintAptRounds
4e82fe5213bedcb70e25c0270e516d5f2706d8c8Tom GundersenPrint information about initial and recursive \f2apt\fP rounds.
d0aa9ce51915f6f7448adfeb4be0f46cc1356124Zbigniew Jędrzejewski-Szmek\-XPrintFactoryInfo
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringPrint information about which annotations a factory is asked to process.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering\-XclassesAsDecls
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart PoetteringTreat both class and source files as declarations to process.
6b1dc2bd3cdb3bd932b0692be636ddd2879edb92Lennart Poettering\f3Note\fP: Because these options are non\-standard, they are subject to change without notice.
b9f111b93f9f442f00266f338b14f25ca8685352Zbigniew Jędrzejewski-SzmekThe \f2apt\fP tool and its associated API contained in the package \f2com.sun.mirror\fP have been deprecated since JDK 7 and are planned to be removed in the next major JDK release. Use the options available in the \f2javac(1)\fP tool and the APIs contained in the packages \f2javax.annotation.processing\fP and \f2javax.lang.model\fP to process annotations.
3d22d1ab57bf44c92e4d9ca95d9728105dd3fb0dTom Gundersen.SH "SEE ALSO"
deb0a77cf0b409141c4b116ae30becb3d878e1adMichael Olbrichjavac(1), java(1)