apt.1 revision 0
2080N/A.'" t
3909N/A."
2080N/A." Copyright 2004-2006 Sun Microsystems, Inc. All Rights Reserved.
2080N/A." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
2080N/A."
2080N/A." This code is free software; you can redistribute it and/or modify it
2362N/A." under the terms of the GNU General Public License version 2 only, as
2080N/A." published by the Free Software Foundation.
2362N/A."
2080N/A." This code is distributed in the hope that it will be useful, but WITHOUT
2080N/A." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
2080N/A." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
2080N/A." version 2 for more details (a copy is included in the LICENSE file that
2080N/A." accompanied this code).
2080N/A."
2080N/A." You should have received a copy of the GNU General Public License version
2080N/A." 2 along with this work; if not, write to the Free Software Foundation,
2080N/A." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
2080N/A."
2080N/A." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
2362N/A." CA 95054 USA or visit www.sun.com if you need additional information or
2362N/A." have any questions.
2362N/A."
2080N/A." `
2080N/A.TH apt 1 "05 Aug 2006"
2080N/A." Generated by html2roff
2080N/A
2080N/A.LP
2080N/A.SH "NAME"
2080N/A.LP
2080N/A.LP
2080N/A\f2apt\fP \- annotation processing tool
2080N/A.LP
2080N/A.SH "SYNOPSIS"
2080N/A.LP
2080N/A.LP
2080N/A\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]
2080N/A.LP
2080N/A.SH "PARAMETERS"
2080N/A.LP
2080N/A.LP
2080N/AOptions may be in any order. For a discussion of parameters which apply to a specific option, see OPTIONS below.
2080N/A.LP
2080N/A.TP 3
2080N/Asourcefiles
2080N/AZero or more source files to be processed.
2080N/A.TP 3
2080N/A@files
2080N/AOne or more files that list source files or other options
2080N/A.LP
2080N/A.SH "DESCRIPTION"
2080N/A.LP
2080N/A.LP
2080N/AThe tool \f2apt\fP, annotation processing tool, includes a set of new 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.
2080N/A.LP
2080N/A.LP
2080N/AA fuller discussion of how the tool operates as well as instructions for developing with \f2apt\fP are in
2080N/A.na
2080N/A\f4Getting Started with \fP\f4apt\fP. @
2080N/A.fi
2080N/Ahttp://java.sun.com/javase/6/docs/technotes/guides/apt/GettingStarted.html
2080N/A.LP
2080N/A.TP 3
2080N/ANote:
2080N/A\f2The functionality of \fP\f2apt\fP has been subsumed by the annotation\-processing infrastructure that is now part of the \f2javac\fP tool [
2080N/A.na
2080N/A\f2Solaris and Linux\fP @
2080N/A.fi
2080N/Ahttp://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html] [Windows] and standardized for use by all Java compilers. This new infrastructure relies on the language model and annotation\-processing APIs that are now part of the Java Platform. It is recommended that new annotation processor development be based on the new APIs and the \f2javac\fP tool.
2080N/A.LP
2080N/A.SH "OPTIONS"
2080N/A.LP
2080N/A.SS
2080N/Aapt specific options
2080N/A.LP
2080N/A.TP 3
2080N/A\-s dir
2080N/ASpecify the directory root under which processor\-generated source files will be placed; files are placed in subdirectories based on package namespace.
2080N/A.TP 3
2080N/A\-nocompile
2080N/ADo not compile source files to class files.
2080N/A.TP 3
2080N/A\-print
2080N/APrint out textual representation of specified types; perform no annotation processing or compilation.
2080N/A.TP 3
2080N/A\-A[key[=val]]
2080N/AOptions to pass to annotation processors \-\- these are not interpreted by \f2apt\fP directly, but are made available for use by individual processors
2080N/A.TP 3
2080N/A\-factorypath path
2080N/ASpecify where to find annotation processor factories; if this option is used, the classpath is \f2not\fP searched for factories.
2080N/A.TP 3
2080N/A\-factory classname
2080N/AName of annotation processor factory to use; bypasses default discovery process
2080N/A.LP
2080N/A.SS
2080N/AOptions shared with javac
2080N/A.LP
2080N/A.TP 3
2080N/A\-d dir
2080N/ASpecify where to place processor and javac generated class files
2080N/A.TP 3
2080N/A\-cp path or \-classpath
2080N/Apath
2080N/ASpecify where to find user class files and annotation processor factories. If \f2\-factorypath\fP is given, the classpath is not searched for factories.
2080N/A.LP
2080N/A.LP
2080N/AConsult the javac(1) man page for information on \f2javac\fP options.
2080N/A.LP
2080N/A.SH "NOTES"
2080N/A.LP
.LP
The functionality of \f2apt\fP has been subsumed by the standard annotation\-processing infrastructure now offered by \f2javac\fP. Support for \f2apt\fP and its associated APIs may be discontinued in some future JDK release.
.LP
.SH "SEE ALSO"
.LP
.RS 3
.TP 2
*
javac: [
.na
\f2Solaris and Linux\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html] [Windows]
.TP 2
*
java: [
.na
\f2Solaris\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/solaris/java.html] [
.na
\f2Linux\fP @
.fi
http://java.sun.com/javase/6/docs/technotes/tools/linux/java.html] [Windows]
.RE
.LP