dt.ecj.3.21.0.source-code.ecj.1 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ecj Show documentation
Show all versions of ecj Show documentation
Eclipse Compiler for Java(TM)
.TH ecj "13 March 2017"
.LP
.SH NAME
ecj \- the eclipse JDT Batch Compiler
.SH SYNOPSIS
.B ecj [OPTION]... [SOURCEFILE]...
.B ...
.SH DESCRIPTION
.B ecj is the batch compiler from Eclipse and is available as ecj.jar.
Since 3.3, this jar also contains the support for jsr199 (Compiler API)
and the support for jsr269 (Annotation processing). In order to use the
annotations processing support, a 1.6 VM is required.
.SH OPTIONS SUMMARY
.sp
Here is a summary of all the options, grouped by type. Explanations are in the \fBOPTIONS\fR section.
.sp
.ul
Module Options
.sp
.B --add-exports \--add-modules \--add-reads \--limit-modules \-p|--module-path \--module-source-path \ --processor-module-path \--system
.sp
.ul
ClassPath Options
.sp
.B \-bootclasspath \-cp|\-classpath \-extdirs \-endorseddirs \-sourcepath \-d \-encoding
.sp
.ul
Compliance Options
.sp
.B \-target \-1.3 \-1.4 \-1.5 \-1.6 \-1.7 \-1.8 \1.9 \-source \ --release
.sp
.ul
Warning Options
.sp
.B \-?:warn \-help:warn \-warn:... \-nowarn \-err:... \-deprecation \-properties
.sp
.ul
Debug Options
.sp
\fB\-g \-preserveAllLocals \-parameters
.sp
.ul
Annotation Processing Options
.sp
\-Akey[=\fIvalue\fB] \-proc:[only|none] \-processor \-processorpath \-s \-XprintProcessorInfo \-XprintRounds \-classNames\fR
.sp
.ul
Ignored Options (for compatibility with javac options)
.sp
.B \-J \-X \-O
.sp
.ul
Advanced Options
.sp
\fB@ \-maxProblems \-log \-Xemacs \-proceedOnError \-verbose \-referenceInfo \-progress \-time \-noExit \-repeat \-inlineJSR \-enableJavaDoc \-missingNullDefault
.sp
.ul
Helping Options
.sp
\-? \-help \-v \-version \-showversion
.SH OPTIONS
.sp
.ul
Module Options (Supported from 9 onwards)
.B
.IP "--add-exports /=(,)*"
A command line form of exports statement which exports the package in source-module to the comma separated list of target modules.
.B
.IP "--add-modules ,,...,"
Extend the default set of root modules with a list of comma separated modules.
.B
.IP "--add-reads =
A command line form of a requires clause equivalent to adding requires source-module in target modules module-info file.
.B
.IP "--limit-modules ,,...,"
Limit the observable modules to the list of comma separated modules.
.B
.IP "-p|--module-path ;;...;"
This is a list of directories where application modules can be found. Entries are separated by the platform path separator.
.B
.IP "--module-source-path ;;...;"
This is a list of directories where source files for modules can be found. Entries are separated by the platform path separator.
.B
.IP "--processor-module-path "
module path where annotation processors can be found.
.B
.IP "--system "
Override location of system modules.
.P
.ul
ClassPath Options
.B
.IP "\-bootclasspath ;;...;"
This is a list of directories or jar files used to bootstrap the class files used by the compiler. By default the libraries of the running VM are used. Entries are separated by the platform path separator.
Each directory or file can specify access rules for types between '[' and ']'.
If no bootclasspath is specified, the compiler will infer it using the following system properties sun.boot.class.path, vm.boot.class.path or org.apache.harmony.boot.class.path in this order respectively
.B
.IP "\-cp|\-classpath ;dir2;..."
This is a list of directories or jar files used to compile the source files. The default value is the value of the property "java.class.path". Entries are separated by the platform path separator.
Each directory or file can specify access rules for types between '[' and ']' (e.g. [\-X] to forbid access to type X, [~X] to discourage access to type X, [+p/X:\-p/*] to forbid access to all types in package p but allow access to p/X).
The compiler follows the Class-Path clauses of jar files' manifests recursively and appends each referenced jar file to the end of the classpath, provided it is not on the classpath yet.
.B
.IP "\-extdirs ;;...;"
This is a list of directories used to specify the location of extension zip/jar files. Entries are separated by the platform path separator.
.B
.IP "\-endorseddirs ;;...;"
This is a list of directories used to specify the location of endorsed zip/jar files. Entries are separated by the platform path separator.
.B
.IP "\-sourcepath ;;...;"
This is a list of directories used to specify the source files. Entries are separated by the platform path separator. Each directory can specify access rules for types between '[' and ']'.
.B
.IP "\-d |none"
This is used to specify in which directory the generated .class files should be dumped. If it is omitted, no package directory structure is created.
If you want to generate no .class file at all, use \-d none.
.B
.IP "\-encoding "
Specify default encoding for all source files. Custom encoding can also be specified on a per file basis by suffixing each input source file/folder name with []. For example X.java[UTF-8] would specify the UTF-8 encoding for the compilation unit X.java located in the current user directory.
If multiple default source file encodings are specified, the last one will be used.
For example:
.B ... \-encoding UTF-8 X.java[Cp1252] Y.java[UTF-16] Z.java ....
.br
All source files will be read using UTF-8 encoding (this includes Z.java). X.java will be read using Cp1252 encoding and Y.java will be read using UTF-16 encoding.
.sp
.B ... \-encoding UTF-8 -encoding UTF-16 ....
.br
All source files will be read using UTF-16 encoding. The \-encoding option for UTF-8 is ignored.
.sp
.B ... \-encoding Cp1252 /foo/bar/X.java[UTF-16] /foo/bar[UTF-8] ....
.br
All source files will be read using Cp1252 encoding. X.java is the only file inside the /foo/bar directory to be read using the encoding UTF-16. All other files in that directory will use UTF-8 encoding.
.P
.ul
Compliance Options
.B
.IP "\-target 1.1 to 1.9 (or 9, 9.0, etc.)"
This specifies the .class file target setting. The possible value are:
.br
.B 1.1
(major version: 45 minor: 3)
.br
.B 1.2
(major version: 46 minor: 0)
.br
.B 1.3
(major version: 47 minor: 0)
.br
.B 1.4
(major version: 48 minor: 0)
.br
.B 1.5, 5 or 5.0
(major version: 49 minor: 0)
.br
.B 1.6, 6 or 6.0
(major version: 50 minor: 0)
.br
.B 1.7, 7 or 7.0
(major version: 51 minor: 0)
.br
.B 1.8, 8 or 8.0
(major version: 52 minor: 0)
.br
.B 1.9, 9 or 9.0
(major version: 53 minor: 0)
Defaults are:
.br
1.1 in \-1.3 mode
.br
1.2 in \-1.4 mode
.br
1.5 in \-1.5 mode
.br
1.6 in \-1.6 mode
.br
1.7 in \-1.7 mode
.br
1.8 in \-1.8 mode
.br
1.9 in \-1.9 mode
clcd1.1 can be used to generate the StackMap attribute.
.B
.IP \-1.3
Set compliance level to 1.3. Implicit \-source 1.3 \-target 1.1.
.B
.IP \-1.4
Set compliance level to 1.4 (default). Implicit \-source 1.3 \-target 1.2.
.B
.IP \-1.5
Set compliance level to 1.5. Implicit \-source 1.5 \-target 1.5.
.B
.IP \-1.6
Set compliance level to 1.6. Implicit \-source 1.6 \-target 1.6.
.B
.IP \-1.7
Set compliance level to 1.7. Implicit \-source 1.7 \-target 1.7.
.B
.IP \-1.8
Set compliance level to 1.8. Implicit \-source 1.8 \-target 1.8.
.B
.IP \-1.9
Set compliance level to 1.9. Implicit \-source 1.9\-target 1.9.
.B
.IP "\-source 1.1 to 1.9 (or 9, 9.0, etc.)"
This is used to specify the source level expected by the compiler.
The possible value are:
.br
.B 1.3
.br
.B 1.4
.br
.B 1.5, 5 or 5.0
.br
.B 1.6, 6 or 6.0
.br
.B 1.7, 7 or 7.0
.br
.B 1.8, 8 or 8.0
.br
.B 1.9, 9 or 9.0
Defaults are:
.br
1.3 in \-1.3 mode
.br
1.3 in \-1.4 mode
.br
1.5 in \-1.5 mode
.br
1.6 in \-1.6 mode
.br
1.7 in \-1.7 mode
.br
1.8 in \-1.8 mode
.br
1.9 in \-1.9 mode
.br
In 1.4, assert is treated as a keyword. In 1.5 and 1.6, enum and assert are treated as keywords.
.B
.IP "--release N"
Compile for a specific VM version. Used for compiling against older APIs.
.P
.ul
Warning Options
.B
.IP "\-?:warn \-help:warn"
Display advanced warning options
.B
.IP "\-warn:..."
Specify the set of enabled warnings.
.br
.B \-warn:none\fR \t\t\t\t\t\tdisable all warnings
.br
.B \-warn:\fI\fR \tenable exactly the listed warnings
.br
.B \-warn:+\fI\fR \tenable additional warnings
.br
.B \-warn:\-\fI\fR \tdisable specific warnings
Examples:
.B\-warn:unusedLocal,deprecation
.br
enables only the given two warning options and disables all the other options
.sp
.B\-warn:\-unusedLocal,deprecation,+fallthrough
.br
disables unusedLocal and deprecation, enables fallthrough, and leaves the other warning options untouched
.sp
The first column below shows the default state for an option. A mark "+/-" indicates that an option covers several fine grained warning variants, some of which are enabled by default, others disabled. This means that specifying the given option with "+" will enable more warnings than the default, and specifying "-" disables some that are enabled by default.
.sp
+/-
.B allDeadCode
dead code including trivial if (DEBUG) check
.sp
+/-
.B allDeprecation
deprecation even inside deprecated code
.sp
\ -\
.B allJavadoc
invalid or missing Javadoc
.sp
\ -\
.B allOver-ann
all missing @Override annotations (superclass and superinterfaces)
.sp
\ -\
.B all-static-method
all method can be declared as static warnings
.sp
\ +\
.B assertIdentifier
occurrence of assert used as identifier
.sp
\ -\
.B boxing
autoboxing conversion
.sp
\ +\
.B charConcat
when a char array is used in a string concatenation without being converted explicitly to a string
.sp
\ +\
.B compareIdentical
comparing identical expressions
.sp
\ -\
.B conditionAssign
possible accidental boolean assignment
.sp
\ +\
.B constructorName
method with constructor name
.sp
\ +\
.B deadCode
dead code excluding trivial if (DEBUG) check
.sp
\ -\
.B dep\-ann
missing @Deprecated annotation
.sp
+/-
.B deprecation
usage of deprecated type or member outside deprecated code
.sp
\ +\
.B discouraged
use of types matching a discouraged access rule
.sp
\ -\
.B emptyBlock
undocumented empty block
.sp
\ +\
.B enumIdentifier
occurrence of enum used as identifier
.sp
\ +\
.B enumSwitch
incomplete enum switch
.sp
\ -\
.B enumSwitchPedantic
report missing enum switch cases even in the presence of a default case
.sp
\ -\
.B fallthrough
possible fall-through case
.sp
\ -\
.B fieldHiding
field hiding another variable
.sp
\ +\
.B finalBound
type parameter with final bound
.sp
\ +\
.B finally
finally block not completing normally
.sp
\ +\
.B forbidden
use of types matching a forbidden access rule
.sp
\ -\
.B hashCode
missing hashCode() method when overriding equals()
.sp
+/-
.B hiding
macro for fieldHiding, localHiding, maskedCatchBlock, and typeHiding
.sp
\ -\
.B includeAssertNull
raise null warnings for variables that got tainted in an assert expression
.sp
\ -\
.B indirectStatic
indirect reference to static member
.sp
\ -\
.B inheritNullAnnot
consider null annotations as being inherited from an overridden method to any overriding methods
.sp
\ +\
.B intfAnnotation
annotation type used as super interface
.sp
\ +\
.B intfNonInherited
interface non-inherited method compatibility
.sp
\ -\
.B intfRedundant
find redundant superinterfaces
.sp
\ -\
.B invalidJavadoc
macro to toggle the 'malformed Javadoc comments' option and all its sub-options listed below
.sp
\ -\
.B invalidJavadocTag
report invalid Javadoc tags in Javadoc comments.
.sp
\ -\
.B invalidJavadocTagDep
report invalid deprecated references in Javadoc tag arguments
.sp
\ -\
.B invalidJavadocTagNotVisible
report invalid non-visible references in Javadoc tag arguments
.sp
\ -\
.B invalidJavadocVisibility(\fI\fB)
specify visibility modifier ("public", "protected" or "private") for malformed Javadoc tag warnings. Usage example: invalidJavadocVisibility(public)
.sp
\ -\
.B javadoc
invalid Javadoc
.sp
\ -\
.B localHiding
local variable hiding another variable
.sp
\ +\
.B maskedCatchBlock
hidden catch block
.sp
\ -\
.B missingJavadocTags
macro to toggle the 'missing Javadoc tags' option and all its sub-options listed below
.sp
\ -\
.B missingJavadocTagsMethod
report missing Javadoc tags for a method's type parameters
.sp
\ -\
.B missingJavadocTagsOverriding
report missing Javadoc tags in overriding methods
.sp
\ -\
.B missingJavadocTagsVisibility(\fI\fB)
specify visibility modifier ("public", "protected" or "private") for missing Javadoc tags warnings. Usage example: missingJavadocTagsVisibility(public)
.sp
\ -\
.B missingJavadocComments
macro to toggle the 'missing Javadoc comments' option and all its sub-options listed below
.sp
\ -\
.B missingJavadocCommentsOverriding
report missing Javadoc comments in overriding methods
.sp
\ -\
.B missingJavadocCommentsVisibility(\fI\fB)
specify visibility modifier ("public", "protected" or "private") for missing Javadoc comments warnings. Usage example: missingJavadocCommentsVisibility(public)
.sp
\ -\
.B nls
non-nls string literals (lacking of tags //$NON-NLS-)
.sp
\ +\
.B noEffectAssign
assignment with no effect
.sp
\ +\
.B nonnullNotRepeated
nonnull parameter annotation from overridden method is not repeated in an overriding method. Is effective only with the nullAnnot option enabled.
.sp
+/-
.B null
potential missing or redundant null check
.sp
\ -\
.B nullAnnot
enable annotation based null analysis.
If desired, the annotation types to be interpreted by the compiler can be specified by appending (nullable|nonnull|nonnullbydefault), where each annotation type is specified using its fully qualified name.
Usage example: nullAnnot(p.Nullable|p.NonNull|p.NonNullByDefault)
.sp
Enabling this option enables all null-annotation related sub-options. These can be individually controlled using options listed below
.sp
\ -\
.B nullAnnotConflict
report conflicts between null annotation specified and nullness inferred. Is effective only with the nullAnnot option enabled.
.sp
\ -\
.B nullAnnotRedundant
report redundant specification of null annotation. Is effective only with the nullAnnot option enabled.
.sp
\ -\
.B nullDereference
missing null check
.sp
\ -\
.B nullUncheckedConversion
report unchecked conversion from unannotated type to @NonNull type. Is effective only with the nullAnnot option enabled.
.sp
\ -\
.B over-ann
missing @Override annotation (superclass only)
.sp
\ -\
.B paramAssign
assignment to a parameter
.sp
\ +\
.B pkgDefaultMethod
attempt to override package-default method
.sp
\ +\
.B raw
usage a of raw type (instead of a parameterized type)
.sp
+/-
.B resource
(potentially) unsafe usage of resource of type Closeable
.sp
\ -\
.B semicolon
unnecessary semicolon or empty statement
.sp
\ +\
.B serial
missing serialVersionUID
.sp
\ -\
.B specialParamHiding
constructor or setter parameter hiding another field
.sp
+/-
.B static-access
macro for indirectStatic and staticReceiver
.sp
\ -\
.B static-method
an instance method that could be as a static method
.sp
\ +\
.B staticReceiver
if a non static receiver is used to get a static field or call a static method
.sp
\ -\
.B super
overriding a method without making a super invocation
.sp
\ +\
.B suppress
enable @SuppressWarnings
.sp
\ -\
.B switchDefault
switch statement lacking a default case
.sp
\ -\
.B syncOverride
missing synchronized in synchronized method override
.sp
\ -\
.B syntacticAnalysis
perform syntax-based null analysis for fields
.sp
\ -\
.B syntheticAccess
when performing synthetic access for innerclass
.sp
\ -\
.B tasks
enable support for tasks tags in source code
.sp
\ +\
.B typeHiding
type parameter hiding another type
.sp
\ +\
.B unavoidableGenericProblems
report even unavoidable type safety problems due to raw APIs
.sp
\ +\
.B unchecked
unchecked type operation
.sp
\ -\
.B unnecessaryElse
unnecessary else clause
.sp
\ -\
.B unqualifiedField
unqualified reference to field
.sp
+/-
.B unused
macro for unusedImport, unusedLabel, unusedLocal, unusedPrivate, unusedThrown, unusedTypeArgs, and unusedTypeParameter
.sp
\ -\
.B unusedAllocation
allocating an object that is not used
.sp
\ -\
.B unusedArgument
unused method parameter (deprecated option; use unusedParam instead)
.sp
\ +\
.B unusedImport
unused import reference
.sp
\ +\
.B unusedLabel
unused label
.sp
\ +\
.B unusedLocal
unused local variable
.sp
\ +\
.B unusedParam
unused method parameter
.sp
\ +\
.B unusedParamImplementing
unused parameter for implementing method
.sp
\ +\
.B unusedParamIncludeDoc
unused parameter documented in a Javadoc comment tag
.sp
\ +\
.B unusedParamOverriding
unused parameter for overriding method
.sp
\ +\
.B unusedPrivate
unused private member declaration
.sp
\ -\
.B unusedThrown
unused declared thrown exception
.sp
\ -\
.B unusedThrownIncludeDocComment
unused declared thrown exception documented in a Javadoc comment tag
.sp
\ -\
.B unusedThrownExemptExceptionThrowable
report unused declared thrown exception but exempt Exception and Throwable
.sp
\ -\
.B unusedThrownWhenOverriding
unused declared thrown exception in overriding method
.sp
\ +\
.B unusedTypeArgs
unused type arguments for method and constructor
.sp
\ +\
.B unusedTypeParameter
unused type parameter
.sp
\ -\
.B uselessTypeCheck
unnecessary cast/instanceof operation
.sp
\ +\
.B varargsCast
varargs argument need explicit cast
.sp
+/-
.B warningToken
unhandled or unused warning token in @SuppressWarnings
.in
.B
.IP "\-nowarn"
No warning (equivalent to \-warn:none)
.B
.IP "\-err:..."
Specify the set of enabled warnings that are converted to errors.
.br
E.g.
.br
.B \-err:unusedLocal,deprecation
.br
unusedLocal and deprecation warnings will be converted to errors. All other warnings are still reported as warnings.
.B \-err:\fI\fR \tconvert exactly the listed warnings to errors
.br
.B \-err:+\fI\fR \tconvert additional warnings to errors
.br
.B \-err:\-\fI\fR \tremove specific warnings from being converted to errors
.B
.IP \-deprecation
Equivalent to \-warn:+deprecation.
.B
.IP "\-properties "
Set warnings/errors option based on the properties file contents. This option can be used with \-nowarn, \-err:.. or \-warn:.. options, but the last one on the command line sets the options to be used.
The properties file contents can be generated by setting project specific settings on an existing java project and using the file in .settings/org.eclipse.jdt.core.prefs file as a properties file, or a simple text file that is defined entry/value pairs using the constants defined in the org.eclipse.jdt.core.JavaCore class. Of those constants declared in this class, all options starting with "org.eclipse.jdt.core.compiler." are interpreted by the batch compiler.
...
.br
org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
.br
org.eclipse.jdt.core.compiler.problem.assertIdentifier=warning
.br
org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
.br
...
.sp
To ensure that a property file has the same effect when used in the IDE and for the batch compiler, use of the \-properties option will change the defaults for a few options:
.br
.B \-g\fR \t\t\t\t\tdefault changed to all enabled
.br
.B \-preserveAllLocals\fR \t\tdefault changed to enabled
.br
.B \-enableJavadoc\fR \t\tdefault changed to enabled
.br
error/warning \fBforbidden\fR \tdefault changed to error
.P
.ul
Debug Options
.B
.IP "\-g[:none|:lines,vars,source]"
Set the debug attributes level
.br
.B \-g\fR \t\t\t\t\tAll debug info (equivalent to \-g:lines,vars,source)
.br
.B \-g:none\fR \t\t\t\tNo debug info
.br
.B \-g:[lines,vars,source]\fR \tSelective debug info
.br
Not specifying this option is equivalent to setting \-g:lines,source.
.B
.IP "\-preserveAllLocals"
Explicitly request the compiler to preserve all local variables (for debug purpose). If omitted, the compiler will remove unused locals.
.B
.IP "\-parameters"
Explicitly request the compiler to preserve information about the formal parameters of a method (such as their names) to be accessed from reflection libraries, annotation processing, code weaving, and in the debugger. This option is supported from target level 1.8 and later.
Annotation processing options (require a 1.6 VM or above and are used only if the compliance is 1.6)
.P
.ul
Annotation Processing Options
.B
.IP "\-Akey[=value]"
Annotation processors options that are passed to annotation processors. key is made of identifiers separated by dots
.B
.IP "\-proc:[only|none]"
If \-proc:only is specified, the annotation processors will run but no compilation will be performed. If \-proc:none is specified, annotation processors will not be discovered or run; compilation will proceed as if no annotation processors were found. By default the compiler must search the classpath for annotation processors, so specifying \-proc:none may speed compilation if annotation processing is not required.
.B
.IP "\-processor "
Qualified class names of annotation processors to run. If specified, the normal processor discovery process will be skipped.
.B
.IP "\-processorpath ;;...;"
A list of directories or jar files which will be searched for annotation processors. Entries are separated by the platform path separator. If not specified, the classpath will be searched instead.
.B
.IP "\-s "
The directory where generated source files will be created.
.B
.IP "\-XprintProcessorInfo"
Print information about which annotations and which elements a processor is asked to process
.B
.IP "\-XprintRounds"
Print information about annotation processing rounds
.B
.IP "\-classNames "
Qualified names of binary types that need to be processed
.P
.ul
Ignored Options (for compatibility with javac options)
.B
.IP "\-J