|
1 .'" t |
|
2 ." |
|
3 ." Copyright 2004-2006 Sun Microsystems, Inc. All Rights Reserved. |
|
4 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
5 ." |
|
6 ." This code is free software; you can redistribute it and/or modify it |
|
7 ." under the terms of the GNU General Public License version 2 only, as |
|
8 ." published by the Free Software Foundation. |
|
9 ." |
|
10 ." This code is distributed in the hope that it will be useful, but WITHOUT |
|
11 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
12 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
13 ." version 2 for more details (a copy is included in the LICENSE file that |
|
14 ." accompanied this code). |
|
15 ." |
|
16 ." You should have received a copy of the GNU General Public License version |
|
17 ." 2 along with this work; if not, write to the Free Software Foundation, |
|
18 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
19 ." |
|
20 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
|
21 ." CA 95054 USA or visit www.sun.com if you need additional information or |
|
22 ." have any questions. |
|
23 ." |
|
24 ." ` |
|
25 .TH apt 1 "05 Aug 2006" |
|
26 ." Generated by html2roff |
|
27 |
|
28 .LP |
|
29 .SH "NAME" |
|
30 .LP |
|
31 .LP |
|
32 \f2apt\fP \- annotation processing tool |
|
33 .LP |
|
34 .SH "SYNOPSIS" |
|
35 .LP |
|
36 .LP |
|
37 \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] |
|
38 .LP |
|
39 .SH "PARAMETERS" |
|
40 .LP |
|
41 .LP |
|
42 Options may be in any order. For a discussion of parameters which apply to a specific option, see OPTIONS below. |
|
43 .LP |
|
44 .TP 3 |
|
45 sourcefiles |
|
46 Zero or more source files to be processed. |
|
47 .TP 3 |
|
48 @files |
|
49 One or more files that list source files or other options |
|
50 .LP |
|
51 .SH "DESCRIPTION" |
|
52 .LP |
|
53 .LP |
|
54 The 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. |
|
55 .LP |
|
56 .LP |
|
57 A fuller discussion of how the tool operates as well as instructions for developing with \f2apt\fP are in |
|
58 .na |
|
59 \f4Getting Started with \fP\f4apt\fP. @ |
|
60 .fi |
|
61 http://java.sun.com/javase/6/docs/technotes/guides/apt/GettingStarted.html |
|
62 .LP |
|
63 .TP 3 |
|
64 Note: |
|
65 \f2The functionality of \fP\f2apt\fP has been subsumed by the annotation\-processing infrastructure that is now part of the \f2javac\fP tool [ |
|
66 .na |
|
67 \f2Solaris and Linux\fP @ |
|
68 .fi |
|
69 http://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. |
|
70 .LP |
|
71 .SH "OPTIONS" |
|
72 .LP |
|
73 .SS |
|
74 apt specific options |
|
75 .LP |
|
76 .TP 3 |
|
77 \-s dir |
|
78 Specify the directory root under which processor\-generated source files will be placed; files are placed in subdirectories based on package namespace. |
|
79 .TP 3 |
|
80 \-nocompile |
|
81 Do not compile source files to class files. |
|
82 .TP 3 |
|
83 \-print |
|
84 Print out textual representation of specified types; perform no annotation processing or compilation. |
|
85 .TP 3 |
|
86 \-A[key[=val]] |
|
87 Options to pass to annotation processors \-\- these are not interpreted by \f2apt\fP directly, but are made available for use by individual processors |
|
88 .TP 3 |
|
89 \-factorypath path |
|
90 Specify where to find annotation processor factories; if this option is used, the classpath is \f2not\fP searched for factories. |
|
91 .TP 3 |
|
92 \-factory classname |
|
93 Name of annotation processor factory to use; bypasses default discovery process |
|
94 .LP |
|
95 .SS |
|
96 Options shared with javac |
|
97 .LP |
|
98 .TP 3 |
|
99 \-d dir |
|
100 Specify where to place processor and javac generated class files |
|
101 .TP 3 |
|
102 \-cp path or \-classpath |
|
103 path |
|
104 Specify where to find user class files and annotation processor factories. If \f2\-factorypath\fP is given, the classpath is not searched for factories. |
|
105 .LP |
|
106 .LP |
|
107 Consult the javac(1) man page for information on \f2javac\fP options. |
|
108 .LP |
|
109 .SH "NOTES" |
|
110 .LP |
|
111 .LP |
|
112 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. |
|
113 .LP |
|
114 .SH "SEE ALSO" |
|
115 .LP |
|
116 .RS 3 |
|
117 .TP 2 |
|
118 * |
|
119 javac: [ |
|
120 .na |
|
121 \f2Solaris and Linux\fP @ |
|
122 .fi |
|
123 http://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html] [Windows] |
|
124 .TP 2 |
|
125 * |
|
126 java: [ |
|
127 .na |
|
128 \f2Solaris\fP @ |
|
129 .fi |
|
130 http://java.sun.com/javase/6/docs/technotes/tools/solaris/java.html] [ |
|
131 .na |
|
132 \f2Linux\fP @ |
|
133 .fi |
|
134 http://java.sun.com/javase/6/docs/technotes/tools/linux/java.html] [Windows] |
|
135 .RE |
|
136 |
|
137 .LP |
|
138 |