23 ." 

    21 ."

    24 ." `

    22 .TH javac 1 "04 May 2009"

    25 .TH javac 1 "07 Aug 2006"

    23 ." Generated from HTML by html2man (author: Eric Armstrong)

    26 ." Generated by html2man

    24 

    27 

    25 .LP

    28 .LP

    26 .SH "Name"

    29 .SH NAME

    39 \fP\f3javac\fP [ options ] [ sourcefiles ] [ @argfiles ]

    36         \fP\f3javac\fP [ options ] [ sourcefiles ] [ classes ] [ @argfiles ]

    37 .fl

    38       

    69 The \f3javac\fP tool reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files.

    71 The \f3javac\fP tool reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files. It can also process annotations in Java source files and classes.

    70 .LP

    72 .LP

    71 .LP

    73 .LP

    72 There are two ways to pass source code filenames to \f3javac\fP:

    74 There are two ways to pass source code file names to \f3javac\fP:

   151 \-classpath classpath 

   113 \-Akey[=value] 

   152 Set the user class path, overriding the user class path in the \f3CLASSPATH\fP environment variable. If neither \f3CLASSPATH\fP or \f3\-classpath\fP is specified, the user class path consists of the current directory. See Setting the Class Path for more details. 

   114 Options to pass to annotation processors. These are not interpreted by javac directly, but are made available for use by individual processors. \f2key\fP should be one or more identifiers separated by ".". 

   153 .LP

   115 .TP 3

   154 If the \f3\-sourcepath\fP option is not specified, the user class path is searched for both source files and class files.  

   116 \-cp path or \-classpath path 

   155 .LP

   117 Specify where to find user class files, and (optionally) annotation processors and source files. This classpath overrides the user class path in the \f3CLASSPATH\fP environment variable. If neither \f3CLASSPATH\fP, \f3\-cp\fP nor \f3\-classpath\fP is specified, the user class path consists of the current directory. See 

   156 As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a java program cannot tell the difference between the two invocations).

   118 .na

   119 \f2Setting the Class Path\fP @

   120 .fi

   121 http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath for more details. 

   122 .LP

   123 If the \f3\-sourcepath\fP option is not specified, the user class path is also searched for source files. 

   124 .LP

   125 If the \f3\-processorpath\fP option is not specified, the classpath is also searched for annotation processors.  

   126 .LP

   127 As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP.

   159 For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP.   

   130 For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. \f3Note:\fP \  Depending of the configuration of your command line environment, you may have to quote the wild card character, for example, \f2javac \-cp "*.jar" MyClass.java\fP.  

   168 Set the destination directory for class files. The destination directory must already exist; javac will not create the destination directory. If a class is part of a package, \f3javac\fP puts the class file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-d /home/myclasses\fP and the class is called \f2com.mypackage.MyClass\fP, then the class file is called \f2/home/myclasses/com/mypackage/MyClass.class\fP. 

   139 Set the destination directory for class files. The directory must already exist; \f3javac\fP will not create it. If a class is part of a package, \f3javac\fP puts the class file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-d /home/myclasses\fP and the class is called \f2com.mypackage.MyClass\fP, then the class file is called \f2/home/myclasses/com/mypackage/MyClass.class\fP. 

   169 .LP

   140 .LP

   170 If \f3\-d\fP is not specified, \f3javac\fP puts the class file in the same directory as the source file. 

   141 If \f3\-d\fP is not specified, \f3javac\fP puts each class files in the same directory as the source file from which it was generated. 

   175 Show a description of each use or override of a deprecated member or class. Without \f3\-deprecation\fP, \f3javac\fP shows the names of source files that use or override deprecated members or classes. \f3\-deprecation\fP is shorthand for \f3\-Xlint:deprecation\fP. 

   146 Show a description of each use or override of a deprecated member or class. Without \f3\-deprecation\fP, \f3javac\fP shows a summary of the source files that use or override deprecated members or classes. \f3\-deprecation\fP is shorthand for \f3\-Xlint:deprecation\fP. 

   178 Set the source file encoding name, such as \f2EUC\-JP and UTF\-8.\fP. If \f3\-encoding\fP is not specified, the platform default converter is used. 

   149 Set the source file encoding name, such as \f2EUC\-JP and UTF\-8\fP. If \f3\-encoding\fP is not specified, the platform default converter is used. 

   205 .LP

   179 .TP 3

   180 \-proc: {none,only} 

   181 Controls whether annotation processing and/or compilation is done. \f3\-proc:none\fP means that compilation takes place without annotation processing. \f3\-proc:only\fP means that only annotation processing is done, without any subsequent compilation. 

   182 .TP 3

   183 \-processor class1[,class2,class3...] 

   184 Names of the annotation processors to run. This bypasses the default discovery process. 

   185 .TP 3

   186 \-processorpath path 

   187 Specify where to find annotation processors; if this option is not used, the classpath will be searched for processors. 

   188 .TP 3

   189 \-s dir 

   190 Specify the directory where to place generated source files. The directory must already exist; \f3javac\fP will not create it. If a class is part of a package, the compiler puts the source file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-s /home/mysrc\fP and the class is called \f2com.mypackage.MyClass\fP, then the source file will be placed in \f2/home/mysrc/com/mypackage/MyClass.java\fP. 

   218 The compiler accepts code containing generics and other language features introduced in JDK 5. This is the default. 

   203 The compiler accepts code containing generics and other language features introduced in JDK 5. 

   221 Synonym for 1.5 

   206 Synonym for 1.5. 

   222 .RE

   207 .TP 3

   223 \f3Note:\fP No language changes were introduced in JDK 6, so the values \f31.6\fP and \f36\fP are not valid. 

   208 1.6 

   209 This is the default value. No language changes were introduced in Java SE 6. However, encoding errors in source files are now reported as errors, instead of warnings, as previously. 

   210 .TP 3

   211 6 

   212 Synonym for 1.6. 

   213 .TP 3

   214 1.7 

   215 The compiler accepts code with features introduced in JDK 7. 

   216 .TP 3

   217 7 

   218 Synonym for 1.7. 

   219 .RE

   228 \f3Note:\fP \  Classes found through the classpath are subject to automatic recompilation if their sources are found.  

   224 \f3Note:\fP \  Classes found through the classpath may be subject to automatic recompilation if their sources are also found. See Searching For Types.  

   231 Verbose output. This includes information about each class loaded and each source file compiled.  

   227 Verbose output. This includes information about each class loaded and each source file compiled. 

   228 .TP 3

   229 \-version 

   230 Print version information. 

   251 Generate class files that target a specified version of the VM. Class files will run on the specified target and on later versions, but not on earlier versions of the VM. Valid targets are \f31.1\fP \f31.2\fP \f31.3\fP \f31.4\fP \f31.5\fP (also \f35\fP) and \f31.6\fP (also \f36\fP). 

   250 Generate class files that target a specified version of the VM. Class files will run on the specified target and on later versions, but not on earlier versions of the VM. Valid targets are \f31.1\fP \f31.2\fP \f31.3\fP \f31.4\fP \f31.5\fP (also \f35\fP) \f31.6\fP (also \f36\fP) and \f31.7\fP (also \f37\fP). 

   260 If \-source is \f31.3\fP, the value of \-target is \f31.1\fP 

   259 If \-source is \f31.2\fP, the value of \-target is \f31.4\fP 

   260 .TP 2

   261 o

   262 If \-source is \f31.3\fP, the value of \-target is \f31.4\fP 

   298 \-Xlint:\-xxx 

   300 \-Xlint:\-name 

   299 Disable warning \f3xxx\fP, where \f3xxx\fP is one of the warning names supported for \f3\-Xlint:xxx\fP, below 

   301 Disable warning \f2name\fP, where \f2name\fP is one of the warning names supported for \f3\-Xlint:\fP\f2name\fP, below. 

   314 Check \f2switch\fP blocks for fall\-through cases and provide a warning message for any that are found. Fall\-through cases are cases in a \f2switch\fP block, other than the last case in the block, whose code does not include a \f2break\fP statement, allowing code execution to "fall through" from that case to the next case. For example, the code following the \f2case 1\fP label in this \f2switch\fP block does not contain a \f2break\fP statement: 

   316 Check \f2switch\fP blocks for fall\-through cases and provide a warning message for any that are found. Fall\-through cases are cases in a \f2switch\fP block, other than the last case in the block, whose code does not include a \f2break\fP statement, allowing code execution to "fall through" from that case to the next case. For example, the code following the \f2case 1\fP label in this \f2switch\fP block does not end with a \f2break\fP statement: 

   340 \-Xmaxerrors number 

   344 \-Xmaxerrs number 

   393   C:> \fP\f3javac @argfile\fP

   409   % \fP\f3javac @argfile\fP

   410 .fl

   411       

   417      \-sourcepath \\java\\pubs\\ws\\1.3\\src\\share\\classes

   435      \-sourcepath /java/pubs/ws/1.3/src/share/classes

   436 .fl

   437       

   440 You would then run javac with:

   462 You would then run \f3javac\fP with:

   461 .fi

   485       

   462 

   486 .fl

   487 .fi

   488 

   489 .LP

   490 .SH "ANNOTATION PROCESSING"

   491 .LP

   492 

   493 .LP

   494 .LP

   495 \f3javac\fP provides direct support for annotation processing, superseding the need for the separate annotation processing tool, \f3apt\fP.

   496 .LP

   497 .LP

   498 The API for annotation processors is defined in the \f2javax.annotation.processing\fP and \f2javax.lang.model\fP packages and subpackages.

   499 .LP

   500 .SS 

   501 Overview of annotation processing

   502 .LP

   503 .LP

   504 Unless annotation processing is disabled with the \f3\-proc:none\fP option, the compiler searches for any annotation processors that are available. The search path can be specified with the \f3\-processorpath\fP option; if it is not given, the user class path is used. Processors are located by means of service provider\-configuration files named

   505 .br

   506 \f2\  META\-INF/services/javax.annotation.processing.Processor\fP

   507 .br

   508 on the search path. Such files should contain the names of any annotation processors to be used, listed one per line. Alternatively, processors can be specified explicitly, using the \f3\-processor\fP option.

   509 .LP

   510 .LP

   511 After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process. When a match is found, the processor will be invoked. A processor may "claim" the annotations it processes, in which case no further attempt is made to find any processors for those annotations. Once all annotations have been claimed, the compiler does not look for additional processors.

   512 .LP

   513 .LP

   514 If any processors generate any new source files, another round of annotation processing will occur: any newly generated source files will be scanned, and the annotations processed as before. Any processors invoked on previous rounds will also be invoked on all subsequent rounds. This continues until no new source files are generated.

   515 .LP

   516 .LP

   517 After a round occurs where no new source files are generated, the annotation processors will be invoked one last time, to give them a chance to complete any work they may need to do. Finally, unless the \f3\-proc:only\fP option is used, the compiler will compile the original and all the generated source files.

   518 .LP

   519 .SS 

   520 Implicitly loaded source files

   521 .LP

   522 .LP

   523 To compile a set of source files, the compiler may need to implicitly load additional source files. (See Searching For Types). Such files are currently not subject to annotation processing. By default, the compiler will give a warning if annotation processing has occurred and any implicitly loaded source files are compiled. See the \-implicit option for ways to suppress the warning.

   524 .LP

   525 .SH "SEARCHING FOR TYPES"

   526 .LP

   527 

   528 .LP

   529 .LP

   530 When compiling a source file, the compiler often needs information about a type whose definition did not appear in the source files given on the command line. The compiler needs type information for every class or interface used, extended, or implemented in the source file. This includes classes and interfaces not explicitly mentioned in the source file but which provide information through inheritance.

   531 .LP

   532 .LP

   533 For example, when you subclass \f3java.applet.Applet\fP, you are also using \f3Applet's\fP ancestor classes: \f3java.awt.Panel\fP, \f3java.awt.Container\fP, \f3java.awt.Component\fP, and \f3java.lang.Object\fP.

   534 .LP

   535 .LP

   536 When the compiler needs type information, it looks for a source file or class file which defines the type. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory). The user class path is defined by setting the \f3CLASSPATH\fP environment variable or by using the \f3\-classpath\fP command line option. (For details, see 

   537 .na

   538 \f2Setting the Class Path\fP @

   539 .fi

   540 http://java.sun.com/javase/6/docs/technotes/tools/index.html#classpath).

   541 .LP

   542 .LP

   543 If you set the \-sourcepath option, the compiler searches the indicated path for source files; otherwise the compiler searches the user class path for both class files and source files.

   544 .LP

   545 .LP

   546 You can specify different bootstrap or extension classes with the \f3\-bootclasspath\fP and \f3\-extdirs\fP options; see Cross\-Compilation Options below.

   547 .LP

   548 .LP

   549 A successful type search may produce a class file, a source file, or both. If both are found, you can use the \-Xprefer option to instruct the compiler which to use. If \f3newer\fP is given, the compiler will use the newer of the two files. If \f3source\fP is given, it will use the source file. The default is \f3newer\fP.

   550 .LP

   551 .LP

   552 If a type search finds a source file for a required type, either by itself, or as a result of the setting for \f3\-Xprefer\fP, the compiler will read the source file to get the information it needs. In addition, it will by default compile the source file as well. You can use the \-implicit option to specify the behavior. If \f3none\fP is given, no class files will be generated for the source file. If \f3class\fP is given, class files will be generated for the source file.

   553 .LP

   554 .LP

   555 The compiler may not discover the need for some type information until after annotation processing is complete. If the type information is found in a source file and no \f3\-implicit\fP option is given, the compiler will give a warning that the file is being compiled without being subject to annotation processing. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3\-implicit\fP option to specify whether or not class files should be generated for such source files.

   487 The return value is equivalent to the exit value from javac.

   621 The return value is equivalent to the exit value from \f3javac\fP.

   643 % \fP\f3javac \-classpath /examples:/lib/Banners.jar \\   

   786 % \fP\f3javac \-classpath /examples:/lib/Banners.jar \\ 

   644 .fl

   787 .fl

   645                    /examples/greetings/Hi.java\fP

   788             /examples/greetings/Hi.java\fP

   789 .fl

   790         

   700 % \f3javac \-sourcepath src \-classpath classes:lib/Banners.jar \\  

   847 % \f3javac \-sourcepath src \-classpath classes:lib/Banners.jar \\ 

   701 .fl

   848 .fl

   702   src/farewells/GoodBye.java \-d classes\fP

   849             src/farewells/GoodBye.java \-d classes\fP

   729 Here we use \f3javac\fP to compile code that will run on a 1.4 VM.

   878 Here we use \f3javac\fP to compile code that will run on a 1.7 VM.

   730 .LP

   879 .LP

   731 .RS 3

   880 .RS 3

   732 

   881 

   733 .LP

   882 .LP

   734 .nf

   883 .nf

   735 \f3

   884 \f3

   736 .fl

   885 .fl

   737 % \fP\f3javac \-target 1.4 \-bootclasspath jdk1.4.2/lib/classes.zip \\  

   886 % \fP\f3javac \-target 1.7 \-bootclasspath jdk1.7.0/lib/rt.jar \\ 

   738 .fl

   887 .fl

   739         \-extdirs "" OldCode.java\fP

   888             \-extdirs "" OldCode.java\fP

   740 .fl

   889 .fl

   741 .fi

   890         

   742 .RE

   891 .fl

   743 

   892 .fi

   744 .LP

   893 .RE

   745 .LP

   894 

   746 The \f3\-target 1.4\fP option ensures that the generated class files will be compatible with 1.4 VMs. By default, \f3javac\fP compiles for JDK 6.

   895 .LP

   747 .LP

   896 .LP

   748 .LP

   897 The \f3\-target 1.7\fP option ensures that the generated class files will be compatible with 1.7 VMs. By default, \f3javac\fP compiles for JDK 6.

   749 The Java Platform JDK's \f3javac\fP would also by default compile against its own bootstrap classes, so we need to tell \f3javac\fP to compile against JDK 1.4 bootstrap classes instead. We do this with \f3\-bootclasspath\fP and \f3\-extdirs\fP. Failing to do this might allow compilation against a Java Platform API that would not be present on a 1.4 VM and would fail at runtime.

   898 .LP

   899 .LP

   900 The Java Platform JDK's \f3javac\fP would also by default compile against its own bootstrap classes, so we need to tell \f3javac\fP to compile against JDK 1.7 bootstrap classes instead. We do this with \f3\-bootclasspath\fP and \f3\-extdirs\fP. Failing to do this might allow compilation against a Java Platform API that would not be present on a 1.7 VM and would fail at runtime.

   759 java \- the Java Application Launcher 

   910 .na

   760 .TP 2

   911 \f2The javac Guide\fP @

   761 o

   912 .fi

   762 jdb \- Java Application Debugger 

   913 http://java.sun.com/javase/6/docs/technotes/guides/javac/index.html 

   763 .TP 2

   914 .TP 2

   764 o

   915 o

   765 javah \- C Header and Stub File Generator 

   916 java(1) \- the Java Application Launcher 

   766 .TP 2

   917 .TP 2

   767 o

   918 o

   768 javap \- Class File Disassembler 

   919 jdb(1) \- Java Application Debugger 

   769 .TP 2

   920 .TP 2

   770 o

   921 o

   771 javadoc \- API Documentation Generator 

   922 javah(1) \- C Header and Stub File Generator 

   772 .TP 2

   923 .TP 2

   773 o

   924 o

   774 jar \- JAR Archive Tool 

   925 javap(1) \- Class File Disassembler 

   926 .TP 2

   927 o

   928 javadoc(1) \- API Documentation Generator 

   929 .TP 2

   930 o

   931 jar(1) \- JAR Archive Tool