Note: Classes found through the class path may be subject to automatic recompilation if their sources are also found. See Searching For Types.

-verbose Verbose output. This includes information about each class loaded and each source file compiled. -version Print version information. -Werror Terminate compilation if warnings occur. -X Display information about non-standard options and exit.

Cross-Compilation Options

By default, classes are compiled against the bootstrap and extension classes of the platform that javac shipped with. But javac 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 -bootclasspath and -extdirs when cross-compiling; see Cross-Compilation Example below.

-target version 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 1.1, 1.2, 1.3, 1.4, 1.5 (also 5), 1.6 (also 6), and 1.7 (also 7).

The default for -target depends on the value of -source:

• If -source is not specified, the value of -target is 1.7
• If -source is 1.2, the value of -target is 1.4
• If -source is 1.3, the value of -target is 1.4
• If -source is 1.5, the value of -target is 1.7
• If -source is 1.6, the value of -target is 1.7
• For all other values of -source, the value of -target is the value of -source.

-bootclasspathbootclasspath Cross-compile 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.

Non-Standard Options

Warnings That Can Be Enabled or Disabled with -Xlint Option

Enable warning name with the option -Xlint:name, where name is one of the following warning names. Similarly, you can disable warning name with the option -Xlint:-name:

cast Warn about unnecessary and redundant casts. For example: classfile Warn about issues related to classfile contents. deprecation Warn about use of deprecated items. For example:

The method java.util.Date.getDay has been deprecated since JDK 1.1.

dep-ann Warn about items that are documented with an @deprecated Javadoc comment, but do not have a @Deprecated annotation. For example: divzero Warn about division by constant integer 0. For example: empty Warn about empty statements after if statements. For example: fallthrough Check switch blocks for fall-through cases and provide a warning message for any that are found. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to «fall through» from that case to the next case. For example, the code following the case 1 label in this switch block does not end with a break statement:

If the -Xlint:fallthrough flag were used when compiling this code, the compiler would emit a warning about «possible fall-through into case,» along with the line number of the case in question.

finally Warn about finally clauses that cannot complete normally. For example:

The compiler generates a warning for finally block in this example. When this method is called, it returns a value of 0 , not 1 . A finally block always executes when the try block exits. In this example, if control is transferred to the catch , then the method exits. However, the finally block must be executed, so it is executed, even though control has already been transferred outside the method.

options Warn about issues relating to the use of command line options. See Cross-Compilation Example for an example of this kind of warning. overrides Warn about issues regarding method overrides. For example, consider the following two classes:

The compiler generates a warning similar to the following:

When the compiler encounters a varargs method, it translates the varargs formal parameter into an array. In the method ClassWithVarargsMethod.varargsMethod , the compiler translates the varargs formal parameter String. s to the formal parameter String[] s , an array, which matches the formal parameter of the method ClassWithOverridingMethod.varargsMethod . Consequently, this example compiles.

path Warn about invalid path elements and nonexistent path directories on the command line (with regards to the class path, the source path, and other paths). Such warnings cannot be suppressed with the @SuppressWarnings annotation. For example: processing Warn about issues regarding annotation processing. The compiler generates this warning if you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception. For example, the following is a simple annotation processor:

Source file AnnoProc.java :

Source file AnnosWithoutProcessors.java :

The following commands compile the annotation processor AnnoProc , then run this annotation processor against the source file AnnosWithoutProcessors.java :

When the compiler runs the annotation processor against the source file AnnosWithoutProcessors.java , it generates the following warning:

To resolve this issue, you can rename the annotation defined and used in the class AnnosWithoutProcessors from Anno to NotAnno .

rawtypes Warn about unchecked operations on raw types. The following statement generates a rawtypes warning:

The following does not generate a rawtypes warning:

List is a raw type. However, List is a unbounded wildcard parameterized type. Because List is a parameterized interface, you should always specify its type argument. In this example, the List formal argument is specified with a unbounded wildcard ( ? ) as its formal type parameter, which means that the countElements method can accept any instantiation of the List interface.

serial Warn about missing serialVersionUID definitions on serializable classes. For example:

The compiler generates the following warning:

If a serializable class does not explicitly declare a field named serialVersionUID , then the serialization runtime will calculate a default serialVersionUID value for that class based on various aspects of the class, as described in the Java Object Serialization Specification. However, it is strongly recommended that all serializable classes explicitly declare serialVersionUID values because the default process of computing serialVersionUID vales is highly sensitive to class details that may vary depending on compiler implementations, and can thus result in unexpected InvalidClassExceptions during deserialization. Therefore, to guarantee a consistent serialVersionUID value across different Java compiler implementations, a serializable class must declare an explicit serialVersionUID value.

static Warn about issues relating to use of statics. For example:

The compiler generates the following warning:

To resolve this issue, you can call the static method m1 as follows:

Alternatively, you can remove the static keyword from the declaration of the method m1 .

try Warn about issues relating to use of try blocks, including try-with-resources statements. For example, a warning is generated for the following statement because the resource ac declared in the try statement is not used: unchecked Give more detail for unchecked conversion warnings that are mandated by the Java Language Specification. For example:

During type erasure, the types ArrayList and List become ArrayList and List , respectively.

The variable ls has the parameterized type List . When the List referenced by l is assigned to ls , the compiler generates an unchecked warning; the compiler is unable to determine at compile time, and moreover knows that the JVM will not be able to determine at runtime, if l refers to a List type; it does not. Consequently, heap pollution occurs.

In detail, a heap pollution situation occurs when the List object l , whose static type is List , is assigned to another List object, ls , that has a different static type, List . However, the compiler still allows this assignment. It must allow this assignment to preserve backwards compatibility with versions of Java SE that do not support generics. Because of type erasure, List and List both become List . Consequently, the compiler allows the assignment of the object l , which has a raw type of List , to the object ls .

varargs Warn about unsafe usages of variable arguments (varargs) methods, in particular, those that contain non-reifiable arguments. For example:

The compiler generates the following warning for the definition of the method ArrayBuilder.addToList :

When the compiler encounters a varargs method, it translates the varargs formal parameter into an array. However, the Java programming language does not permit the creation of arrays of parameterized types. In the method ArrayBuilder.addToList , the compiler translates the varargs formal parameter T. elements to the formal parameter T[] elements , an array. However, because of type erasure, the compiler converts the varargs formal parameter to Object[] elements . Consequently, there is a possibility of heap pollution.

COMMAND LINE ARGUMENT FILES

To shorten or simplify the javac command line, you can specify one or more files that themselves contain arguments to the javac command (except -J options). This enables you to create javac commands of any length on any operating system.

An argument file can include javac options and source filenames in any combination. The arguments within a file can be space-separated or newline-separated. If a filename contains embedded spaces, put the whole filename in double quotes, and double each backslash ( «My Files\\Stuff.java» ).

Filenames within an argument file are relative to the current directory, not the location of the argument file. Wildcards (*) are not allowed in these lists (such as for specifying *.java ). Use of the ‘@‘ character to recursively interpret files is not supported. The -J options are not supported because they are passed to the launcher, which does not support argument files.

When executing javac, pass in the path and name of each argument file with the ‘@‘ leading character. When javac encounters an argument beginning with the character `@‘, it expands the contents of that file into the argument list.

Example — Single Arg File

You could use a single argument file named » argfile » to hold all javac arguments:

This argument file could contain the contents of both files shown in the next example.

Example — Two Arg Files

You can create two argument files — one for the javac options and the other for the source filenames: (Notice the following lists have no line-continuation characters.)

Create a file named » options » containing:

Create a file named » classes » containing:

You would then run javac with:

Example — Arg Files with Paths

The argument files can have paths, but any filenames inside the files are relative to the current working directory (not path1 or path2 ):

ANNOTATION PROCESSING

javac provides direct support for annotation processing, superseding the need for the separate annotation processing tool, apt.

The API for annotation processors is defined in the javax.annotation.processing and javax.lang.model packages and subpackages.

Overview of annotation processing

Unless annotation processing is disabled with the -proc:none option, the compiler searches for any annotation processors that are available. The search path can be specified with the -processorpath option; if it is not given, the user class path is used. Processors are located by means of service provider-configuration files named META-INF/services/javax.annotation.processing.Processor 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 -processor option.

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.

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.

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 -proc:only option is used, the compiler will compile the original and all the generated source files.

Implicitly loaded source files

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.

SEARCHING FOR TYPES

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.

For example, when you subclass java.applet.Applet, you are also using Applet’s ancestor classes: java.awt.Panel, java.awt.Container, java.awt.Component, and java.lang.Object.

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 CLASSPATH environment variable or by using the -classpath command line option. (For details, see Setting the Class Path).

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.

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

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 newer is given, the compiler will use the newer of the two files. If source is given, it will use the source file. The default is newer.

If a type search finds a source file for a required type, either by itself, or as a result of the setting for -Xprefer, 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 none is given, no class files will be generated for the source file. If class is given, class files will be generated for the source file.

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 -implicit 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 -implicit option to specify whether or not class files should be generated for such source files.

PROGRAMMATIC INTERFACE

javac supports the new Java Compiler API defined by the classes and interfaces in the javax.tools package.

Example

To perform a compilation using arguments as you would give on the command line, you can use the following:

This will write any diagnostics to the standard output stream, and return the exit code that javac would give when invoked from the command line.

You can use other methods on the javax.tools.JavaCompiler interface to handle diagnostics, control where files are read from and written to, and so on.

Old Interface

Note: This API is retained for backwards compatibility only; all new code should use the Java Compiler API, described above.

The com.sun.tools.javac.Main class provides two static methods to invoke the compiler from a program:

The args parameter represents any of the command line arguments that would normally be passed to the javac program and are outlined in the above Synopsis section.

The out parameter indicates where the compiler’s diagnostic output is directed.

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

Note that all other classes and methods found in a package whose name starts with com.sun.tools.javac (informally known as sub-packages of com.sun.tools.javac ) are strictly internal and subject to change at any time.

EXAMPLES

Compiling a Simple Program

The following source file, C:\greetings\Hello.java , defines a class called greetings.Hello:

The greetings directory is the package directory both for the source file and the class file and is off the current directory. This allows us to use the default user class path. It also makes it unnecessary to specify a separate destination directory with -d.

Compiling Multiple Source Files

This example compiles all the source files in the package greetings .

Specifying a User Class Path

Having changed one of the source files in the previous example, we recompile it:

Since greetings.Hi refers to other classes in the greetings package, the compiler needs to find these other classes. The example above works, because our default user class path happens to be the directory containing the package directory. But suppose we want to recompile this file and not worry about which directory we’re in? Then we need to add \examples to the user class path. We can do this by setting CLASSPATH, but here we’ll use the -classpath option.

If we change greetings.Hi again, to use a banner utility, that utility also needs to be accessible through the user class path.

To execute a class in greetings , we need access both to greetings and to the classes it uses.

Separating Source Files and Class Files

It often makes sense to keep source files and class files in separate directories, especially on large projects. We use -d to indicate the separate class file destination. Since the source files are not in the user class path, we use -sourcepath to help the compiler find them.

Note: The compiler compiled src\farewells\Base.java , even though we didn’t specify it on the command line. To trace automatic compiles, use the -verbose option.

Cross-Compilation Example

The following example uses javac to compile code that will run on a 1.6 VM.

The -source 1.6 option specifies that version 1.6 (or 6) of the Java programming language be used to compile OldCode.java . The option -target 1.6 option ensures that the generated class files will be compatible with 1.6 VMs. Note that in most cases, the value of the -target option is the value of the -source option; in this example, you can omit the -target option.

You must specify the -bootclasspath option to specify the correct version of the bootstrap classes (the rt.jar library). If not, the compiler generates a warning:

If you do not specify the correct version of bootstrap classes, the compiler will use the old language rules (in this example, it will use version 1.6 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to non-existent methods can get included.