'\" t

.\"  Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved.

.\"

.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

.\"

.\" This code is free software; you can redistribute it and/or modify it

.\" under the terms of the GNU General Public License version 2 only, as

.\" published by the Free Software Foundation.

.\"

.\" This code is distributed in the hope that it will be useful, but WITHOUT

.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License

.\" version 2 for more details (a copy is included in the LICENSE file that

.\" accompanied this code).

.\"

.\" You should have received a copy of the GNU General Public License version

.\" 2 along with this work; if not, write to the Free Software Foundation,

.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

.\"

.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

.\" or visit www.oracle.com if you need additional information or have any

.\" questions.

.\"

.\"     Arch: generic

.\"     Software: JDK 8

.\"     Date: 21 November 2013

.\"     SectDesc: Basic Tools

.\"     Title: javac.1

.\"

.if n .pl 99999

.TH javac 1 "21 November 2013" "JDK 8" "Basic Tools"

.\" -----------------------------------------------------------------

.\" * Define some portability stuff

.\" -----------------------------------------------------------------

.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.\" http://bugs.debian.org/507673

.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html

.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.ie \n(.g .ds Aq \(aq

.el       .ds Aq '

.\" -----------------------------------------------------------------

.\" * set default formatting

.\" -----------------------------------------------------------------

.\" disable hyphenation

.nh

.\" disable justification (adjust text to left margin only)

.ad l

.\" -----------------------------------------------------------------

.\" * MAIN CONTENT STARTS HERE *

.\" -----------------------------------------------------------------

.SH NAME    

javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&.

.SH SYNOPSIS    

.sp     

.nf     

\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ]

.fi     

.sp     

Arguments can be in any order:

.TP     

\fIoptions\fR

Command-line options\&. See Options\&.

.TP     

\fIsourcefiles\fR

One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&.

.TP     

\fIclasses\fR

One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&.

.TP     

\fI@argfiles\fR

One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&.

.SH DESCRIPTION    

The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&.

.PP

There are two ways to pass source code file names to \f3javac\fR\&.

.TP 0.2i    

\(bu

For a small number of source files, list the file names on the command line\&.

.TP 0.2i    

\(bu

For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&.

.PP

Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&.

.PP

Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&.

.PP

Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&.

.PP

By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&.

.SH OPTIONS    

The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&.

.TP 0.2i    

\(bu

See also Cross-Compilation Options

.TP 0.2i    

\(bu

See also Nonstandard Options

.SS STANDARD\ OPTIONS    

.TP

-A\fIkey\fR[\fI=value\fR]

.br

Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&.

.TP

-cp \fIpath\fR or -classpath \fIpath\fR

.br

Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&.

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

If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&.

.TP

-Djava\&.ext\&.dirs=\fIdirectories\fR

.br

Overrides the location of installed extensions\&.

.TP

-Djava\&.endorsed\&.dirs=\fIdirectories\fR

.br

Overrides the location of the endorsed standards path\&.

.TP

-d \fIdirectory\fR

.br

Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&.

If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&.

If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&.

\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&.

.TP

-deprecation

.br

Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&.

.TP

-encoding \fIencoding\fR

.br

Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&.

.TP

-endorseddirs \fIdirectories\fR

.br

Overrides the location of the endorsed standards path\&.

.TP

-extdirs \fIdirectories\fR

.br

Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&.

If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&.

.TP

-g

.br

Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&.

.TP

-g:none

.br

Does not generate any debugging information\&.

.TP

-g:[\fIkeyword list\fR]

.br

Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are:

.RS     

.TP     

source

Source file debugging information\&.

.TP     

lines

Line number debugging information\&.

.TP     

vars

Local variable debugging information\&.

.RE     

.TP

-help

.br

Prints a synopsis of standard options\&.

.TP

-implicit:[\fIclass, none\fR]

.br

Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&.

.TP

-J\fIoption\fR

.br

Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&.

\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&.

.TP

-nowarn

.br

Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&.

.TP

-parameters

.br

Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&.

.TP

-proc: [\fInone\fR, \fIonly\fR]

.br

Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&.

.TP

-processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.]

.br

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

.TP

-processorpath \fIpath\fR

.br

Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&.

.TP

-s \fIdir\fR

.br

Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&.

If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&.

.TP

-source \fIrelease\fR

.br

Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed:

.RS     

.TP     

1\&.3

The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&.

.TP     

1\&.4

The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&.

.TP     

1\&.5

The compiler accepts code containing generics and other language features introduced in Java SE 5\&.

.TP     

5

Synonym for 1\&.5\&.

.TP     

1\&.6

No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&.

.TP     

6

Synonym for 1\&.6\&.

.TP     

1\&.7

This is the default value\&. The compiler accepts code with features introduced in Java SE 7\&.

.TP     

7

Synonym for 1\&.7\&.

.RE     

.TP

-sourcepath \fIsourcepath\fR

.br

Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&.

\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&.

.TP

-verbose

.br

Uses verbose output, which includes information about each class loaded and each source file compiled\&.

.TP

-version

.br

Prints release information\&.

.TP

-werror

.br

Terminates compilation when warnings occur\&.

.TP

-X

.br

Displays information about nonstandard options and exits\&.

.SS CROSS-COMPILATION\ OPTIONS    

By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&.

.TP

-target \fIversion\fR

.br

Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), and 1\&.7 (also 7)\&.

The default for the \f3-target\fR option depends on the value of the \f3-source\fR option:

.RS     

.TP 0.2i    

\(bu

If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.7

.TP 0.2i    

\(bu

If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4

.TP 0.2i    

\(bu

If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4

.TP 0.2i    

\(bu

If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.7

.TP 0.2i    

\(bu

If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.7

.TP 0.2i    

\(bu

For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&.

.RE     

.TP

-bootclasspath \fIbootclasspath\fR

.br

Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&.

.SS COMPACT\ PROFILE\ OPTION    

Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&.

.PP

The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&.

.TP

-profile

.br

When using compact profiles, this option specifies the profile name when compiling\&. For example:

.sp     

.nf     

\f3javac \-profile compact1 Hello\&.java\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code:

.sp     

.nf     

\f3cd jdk1\&.8\&.0/bin\fP

.fi     

.nf     

\f3\&./javac \-profile compact1 Paint\&.java\fP

.fi     

.nf     

\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP

.fi     

.nf     

\f3import java\&.applet\&.Applet;\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.)

An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&.

.SS NONSTANDARD\ OPTIONS    

.TP

-Xbootclasspath/p:\fIpath\fR

.br

Adds a suffix to the bootstrap class path\&.

.TP

-Xbootclasspath/a:\fIpath\fR

.br

Adds a prefix to the bootstrap class path\&.

.TP

-Xbootclasspath/:\fIpath\fR

.br

Overrides the location of the bootstrap class files\&.

.TP

-Xdoclint:[-]\fIgroup\fR [\fI/access\fR]

.br

Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&.

The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public):

.sp     

.nf     

\f3\-Xdoclint:all/protected\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public):

.sp     

.nf     

\f3\-Xdoclint:all,\-html/package\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

.TP

-Xdoclint:none

.br

Disables all groups of checks\&.

.TP

-Xdoclint:all[\fI/access\fR]

.br

Enables all groups of checks\&.

.TP

-Xlint

.br

\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&.

.TP

-Xlint:all

.br

\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&.

.TP

-Xlint:none

.br

Disables all warnings\&.

.TP

-Xlint:\fIname\fR

.br

Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&.

.TP

-Xlint:\fI-name\fR

.br

Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&.

.TP

-Xmaxerrs \fInumber\fR

.br

Sets the maximum number of errors to print\&.

.TP

-Xmaxwarns \fInumber\fR

.br

Sets the maximum number of warnings to print\&.

.TP

-Xstdout \fIfilename\fR

.br

Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&.

.TP

-Xprefer:[\fInewer,source\fR]

.br

Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&.

.TP

-Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR]

.br

Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&.

.RS     

.TP     

always

Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&.

.TP     

legacy

Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&.

\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&.

.TP     

nonempty

Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&.

.RE     

.TP

-Xprint

.br

Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&.

.TP

-XprintProcessorInfo

.br

Prints information about which annotations a processor is asked to process\&.

.TP

-XprintRounds

.br

Prints information about initial and subsequent annotation processing rounds\&.

.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION    

Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&.

.TP     

cast

Warns about unnecessary and redundant casts, for example:

.sp     

.nf     

\f3String s = (String) "Hello!"\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

.TP     

classfile

Warns about issues related to class file contents\&.

.TP     

deprecation

Warns about the use of deprecated items, for example:

.sp     

.nf     

\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP

.fi     

.nf     

\f3int currentDay = myDate\&.getDay();\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1

.TP     

dep-ann

Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example:

.sp     

.nf     

\f3/**\fP