4632N/A." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
4632N/A." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4632N/A."
4632N/A." This code is free software; you can redistribute it and/or modify it
4632N/A." under the terms of the GNU General Public License version 2 only, as
4632N/A." published by the Free Software Foundation.
4632N/A."
4632N/A." This code is distributed in the hope that it will be useful, but WITHOUT
4632N/A." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4632N/A." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4632N/A." version 2 for more details (a copy is included in the LICENSE file that
4632N/A." accompanied this code).
4632N/A."
4632N/A." You should have received a copy of the GNU General Public License version
4632N/A." 2 along with this work; if not, write to the Free Software Foundation,
4632N/A." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
4632N/A."
4632N/A." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
4632N/A." or visit www.oracle.com if you need additional information or have any
4632N/A." questions.
4632N/A."
4632N/A.TH apt 1 "10 May 2011"
4632N/A
4632N/A.LP
4632N/A.SH "NAME"
4632N/A.LP
4632N/A.LP
4632N/A\f2apt\fP \- annotation processing tool
4632N/A.LP
4632N/A.SH "SYNOPSIS"
4632N/A.LP
4632N/A.LP
4632N/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]
4632N/A.LP
4632N/A.SH "PARAMETERS"
4632N/A.LP
4632N/A.LP
4632N/AOptions may be in any order. For a discussion of parameters which apply to a specific option, see OPTIONS below.
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/Asourcefiles
4632N/AZero or more source files to be processed.
4632N/A.TP 3
4632N/A@files
4632N/AOne or more files that list source files or other options
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SH "DESCRIPTION"
4632N/A.LP
4632N/A.LP
4632N/A\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.
4632N/A.LP
4632N/A.LP
4632N/AThe 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.
4632N/A.LP
4632N/A.LP
4632N/AA fuller discussion of how the tool operates as well as instructions for developing with \f2apt\fP are in
4632N/A.na
4632N/A\f4Getting Started with \fP\f4apt\fP. @
4632N/A.fi
4632N/Ahttp://download.oracle.com/javase/7/docs/technotes/guides/apt/GettingStarted.html
4632N/A.LP
4632N/A.SH "OPTIONS"
4632N/A.LP
4632N/A.SS
4632N/Aapt specific options
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/A\-s dir
4632N/ASpecify the directory root under which processor\-generated source files will be placed; files are placed in subdirectories based on package namespace.
4632N/A.TP 3
4632N/A\-nocompile
4632N/ADo not compile source files to class files.
4632N/A.TP 3
4632N/A\-print
4632N/APrint out textual representation of specified types; perform no annotation processing or compilation.
4632N/A.TP 3
4632N/A\-A[key[=val]]
4632N/AOptions to pass to annotation processors \-\- these are not interpreted by \f2apt\fP directly, but are made available for use by individual processors
4632N/A.TP 3
4632N/A\-factorypath path
4632N/ASpecify where to find annotation processor factories; if this option is used, the classpath is \f2not\fP searched for factories.
4632N/A.TP 3
4632N/A\-factory classname
4632N/AName of annotation processor factory to use; bypasses default discovery process
4632N/A.TP 3
4632N/A\-version
4632N/APrint version information.
4632N/A.TP 3
4632N/A\-X
4632N/ADisplay information about non\-standard options.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.SS
4632N/AOptions shared with javac
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/A\-d dir
4632N/ASpecify where to place processor and javac generated class files
4632N/A.TP 3
4632N/A\-cp path or \-classpath path
4632N/ASpecify where to find user class files and annotation processor factories. If \f2\-factorypath\fP is given, the classpath is not searched for factories.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.LP
4632N/AConsult the javac(1) man page for information on \f2javac\fP options.
4632N/A.LP
4632N/A.SS
4632N/ANon\-Standard Options
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 3
4632N/A\-XListAnnotationTypes
4632N/AList found annotation types.
4632N/A.TP 3
4632N/A\-XListDeclarations
4632N/AList specified and included declarations.
4632N/A.TP 3
4632N/A\-XPrintAptRounds
4632N/APrint information about initial and recursive \f2apt\fP rounds.
4632N/A.TP 3
4632N/A\-XPrintFactoryInfo
4632N/APrint information about which annotations a factory is asked to process.
4632N/A.TP 3
4632N/A\-XclassesAsDecls
4632N/ATreat both class and source files as declarations to process.
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A.LP
4632N/A\f3Note\fP: Because these options are non\-standard, they are subject to change without notice.
4632N/A.LP
4632N/A.SH "NOTES"
4632N/A.LP
4632N/A.LP
4632N/AThe \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.
4632N/A.LP
4632N/A.SH "SEE ALSO"
4632N/A.LP
4632N/A.RS 3
4632N/A.TP 2
4632N/Ao
4632N/Ajavac(1), java(1)
4632N/A.RE
4632N/A
4632N/A.LP
4632N/A