apt(1) apt(1)

NAME
       apt - annotation processing tool

SYNOPSIS
       aapptt  [ -ccllaassssppaatthh classpath ] [ -ssoouurrcceeppaatthh sourcepath ] [ -dd directory
       ] [ -ss directory ] [ -ffaaccttoorryyppaatthh path ] [ -ffaaccttoorryy class ] [ -pprriinntt  ]
       [  -nnooccoommppiillee  ] [ -AA [ key [ =val ] ] ] [ jjaavvaacc option ] sourcefiles [
       @@files ]

DESCRIPTION
       The tool apt, annotation processing tool, includes a set of new reflec-
       tive APIs and supporting infrastructure to process program annotations.
       The apt reflective APIs provide a build-time,  source-based,  read-only
       view  of  program  structure.  These  reflective  APIs  are designed to
       cleanly model the JavaTM programming language's type system  after  the
       addition  of  generics.  First, apt runs annotation processors that can
       produce new source code and other files. Next, apt can  cause  compila-
       tion  of  both original and generated source files, easing development.
       The reflective APIs and other APIs used to interact with the  tool  are
       subpackages of com.sun.mirror.

       A  fuller  discussion  of how the tool operates as well as instructions
       for  developing  with  apt  are  in  Getting  Started   with   apt   at
       http://java.sun.com/j2se/1.5.0/docs/guide/apt/GettingStarted.html.

PPAARRAAMMEETTEERRSS
       Options may be in any order. For a discussion of parameters which apply
       to a specific option, see OPTIONS below.

       sourcefiles    Zero or more source files to be processed.

       @@files         One or more  files  that  list  source  files  or  other
                      options.

OOPPTTIIOONNSS
   aapptt ssppeecciiffiicc ooppttiioonnss
       -ss dir         Specify  the directory root under which processor-gener-
                      ated source files will be placed; files  are  placed  in
                      subdirectories based on package namespace.

       -nnooccoommppiillee     Do not compile sources files to class files.

       -pprriinntt         Print  out  textual  representation  of specified types;
                      perform no annotation processing or compilation.

       -AA[[key[[==val]]]]  Options to pass to annotation processors  -  these  are
                      not  interpreted by apt directly, but are made available
                      for use by individual processors

       -ffaaccttoorryyppaatthh path
                      Specify where to find annotation processor factories; if
                      this  option  is used, the classpath is not searched for
                      factories.

       -ffaaccttoorryy classname
                      Name of annotation processor factory  to  use;  bypasses
                      default discovery process

   Options shared with javac
       -dd dir         Specify  where  to  place  processor and javac generated
                      class files

       -ccpp path       or
       -ccllaassssppaatthh path
                      Specify where to find user class  files  and  annotation
                      processor  factories.  If  -ffaaccttoorryyppaatthh  is  given,  the
                      classpath is not searched for factories.

       Consult the jjaavvaacc(1) man page for information on jjaavvaacc options.

NNOOTTEESS
       The apt tool and its associated APIs may be changed  or  superseded  in
       future j2se releases.

SEE ALSO
       jjaavvaacc(1) jjaavvaa(1)



                                 13 June 2004                           apt(1)