For more information on EE File structure see the Wiki Page.
diff --git a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-ant_javac_adapter.htm b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-ant_javac_adapter.htm
index 2795d0b8d21..c087a3a85f5 100644
--- a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-ant_javac_adapter.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-ant_javac_adapter.htm
@@ -1,15 +1,13 @@
-
-
+
+
-
-
-
+
+
Using the ant javac adapter
-
-
+
Using the Ant javac Adapter
The Eclipse compiler can be used inside an Ant buildfile using the javac adapter. In order to use the Eclipse compiler, you simply need to define the build.compiler property in your
buildfile.
diff --git a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-apply_hit_count.htm b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-apply_hit_count.htm
index c92da5f16a4..e5b65e7a63f 100644
--- a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-apply_hit_count.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-apply_hit_count.htm
@@ -1,10 +1,9 @@
-
+
-
-
-
+
+
Applying Hit Counts
diff --git a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-assign_default_jre.htm b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-assign_default_jre.htm
index 105c019a0e4..e8ebfb382aa 100644
--- a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-assign_default_jre.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-assign_default_jre.htm
@@ -1,15 +1,13 @@
-
+
-
-
-
+
+
Assigning the default JRE for the workbench
-
-
+
to suppress warnings relative to missing serialVersionUID field for a serializable class
-
+
Serializable class without serialVersionUID
-
+
static-access
-
+
to suppress warnings relative to incorrect static access
-
+
Non-static access to a static member
Indirect access to a static member
-
+
static-method
-
+
to suppress warnings relative to methods that could be declared as static
-
+
Method can be static
Method can potentially be static
-
+
super
-
+
to suppress warnings relative to overriding a method without super invocations
-
-
+
-
+
synthetic-access
-
+
to suppress warnings relative to unoptimized access from inner classes
-
-
+
-
+
sync-override
-
+
to suppress warnings because of missing synchronize when overriding a synchronized method
-
+
Missing synchronized modifier on inherited method
-
+
unchecked
-
+
to suppress warnings relative to unchecked operations
-
+
Unchecked generic type operation
-
+
unqualified-field-access
-
+
to suppress warnings relative to field access unqualified
-
+
Unqualified access to instance field
-
+
unlikely-arg-type
-
+
to suppress warnings relative to unlikely argument types
-
+
Unqualified access to instance field
-
+
unused
-
+
to suppress warnings relative to unused code and dead code
-
+
Dead code
Unused object allocation
Value of local variable is not used
diff --git a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-suspending_threads.htm b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-suspending_threads.htm
index f0f783d3fdc..9476508b965 100644
--- a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-suspending_threads.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/task-suspending_threads.htm
@@ -1,10 +1,9 @@
-
+
The batch compiler class is located in the JDT Core plug-in. The name of the class is org.eclipse.jdt.compiler.batch.BatchCompiler. It is packaged into
@@ -56,7 +54,7 @@
Which Options Are Available?
When some options are being set multiple times, the batch compiler consumes them from left to right. When the warning option (-warn:....) is used without '+' or '-', this overrides the set of
warnings previously specified. So you should make sure that such an option is given before any other usage of the -warn option.
Same applies for the -err: and -info: options.
-
+
Name
Usage
@@ -66,8 +64,8 @@
Which Options Are Available?
-
-bootclasspath <dir 1>;<dir 2>;...;<dir P>
-
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
+
-bootclasspath <dir 1>;<dir 2>;...;<dir P>
+
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
@@ -77,10 +75,10 @@
Which Options Are Available?
-
-cp
+
-cp
-classpath <dir 1>;<dir 2>;...;<dir P>
-
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
+
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).
@@ -88,73 +86,73 @@
Which Options Are Available?
yet.
-
-extdirs <dir 1>;<dir 2>;...;<dir P>
+
-extdirs <dir 1>;<dir 2>;...;<dir P>
-
This is a list of directories used to specify the location of extension zip/jar files.
+
This is a list of directories used to specify the location of extension zip/jar files.
Entries are separated by the platform path separator. This option is not supported when compliance is 9 over later.
-
-endorseddirs <dir 1>;<dir 2>;...;<dir P>
-
This is a list of directories used to specify the location of endorsed zip/jar files.
+
-endorseddirs <dir 1>;<dir 2>;...;<dir P>
+
This is a list of directories used to specify the location of endorsed zip/jar files.
Entries are separated by the platform path separator. This option is not supported when compliance is 9 over later.
-
-sourcepath <dir 1>;<dir 2>;...;<dir P>
-
This is a list of directories used to specify the source files. Entries are separated by the platform path separator.
+
-sourcepath <dir 1>;<dir 2>;...;<dir P>
+
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 ']'.
-
--module-path <dir 1>;<dir 2>;...;<dir P>
-
This is a list of directories used to specify module locations. Entries are separated by the platform path separator.
+
--module-path <dir 1>;<dir 2>;...;<dir P>
+
This is a list of directories used to specify module locations. Entries are separated by the platform path separator.
Each directory can specify access rules for types between '[' and ']'.
-
--module-source-path <dir 1>;<dir 2>;...;<dir P>
-
This is a list of directories used to specify the source modules that need to be compiler. Entries are separated by the platform path separator.
+
--module-source-path <dir 1>;<dir 2>;...;<dir P>
+
This is a list of directories used to specify the source modules that need to be compiler. Entries are separated by the platform path separator.
Each directory can specify access rules for types between '[' and ']'.
This is a list of directories used to specify the module oriented annotation processors. Entries are separated by the platform path separator.
Each directory can specify access rules for types between '[' and ']'.
-
--system
-
This is a directory pointing to the system modules.
+
--system
+
This is a directory pointing to the system modules.
Specifies additional modules to be considered as required by a given module.
-
--add-modules <module>(,<module>)*
-
Specifies root modules to resolve in addition to the initial modules, or all modules.
+
--add-modules <module>(,<module>)*
+
Specifies root modules to resolve in addition to the initial modules, or all modules.
-
--limit-modules <module>(,<module>)*
-
Limits the observable modules to the list of specified modules.
+
--limit-modules <module>(,<module>)*
+
Limits the observable modules to the list of specified modules.
-
-d <dir 1>|none
+
-d <dir 1>|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.
-
-encoding <encoding name>
+
-encoding <encoding name>
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 [<encoding name>]. For example X.java[UTF-8] would specify the UTF-8 encoding for the compilation unit X.java located in the current user
directory.
@@ -178,7 +176,7 @@
Which Options Are Available?
Compliance options
-
--enable-preview
+
--enable-preview
This specifies whether the compiler should allow
preview Java language features. It is important to note that only
@@ -187,7 +185,7 @@
Which Options Are Available?
-
--release 6, 7, 8, 9, 10, 11, 12, 13, 14 and 15
+
--release 6, 7, 8, 9, 10, 11, 12, 13, 14 and 15
This specifies the VM version that source files should be compiled for.
The support for the specific releases comes from the JVM used. Hence, it is advised to
@@ -212,7 +210,7 @@
Which Options Are Available?
-
-target 1.1 to 15 (or 8, 8.0, etc.)
+
-target 1.1 to 15 (or 8, 8.0, etc.)
This specifies the .class file target setting. The possible value are:
@@ -252,62 +250,62 @@
Which Options Are Available?
-
-1.3
+
-1.3
Set compliance level to 1.3. Implicit -source 1.3 -target 1.1.
-
-1.4
+
-1.4
Set compliance level to 1.4 (default). Implicit -source 1.3 -target 1.2.
-
-1.5
+
-1.5
Set compliance level to 1.5. Implicit -source 1.5 -target 1.5.
-
-1.6
+
-1.6
Set compliance level to 1.6. Implicit -source 1.6 -target 1.6.
-
-1.7
+
-1.7
Set compliance level to 1.7. Implicit -source 1.7 -target 1.7.
-
-1.8
+
-1.8
Set compliance level to 1.8. Implicit -source 1.8 -target 1.8.
-
-9
+
-9
Set compliance level to 9. Implicit -source 9 -target 9.
-
-10
+
-10
Set compliance level to 10. Implicit -source 10 -target 10.
-
-11
+
-11
Set compliance level to 11. Implicit -source 11 -target 11.
-
-12
+
-12
Set compliance level to 12. Implicit -source 12 -target 12.
-
-13
+
-13
Set compliance level to 13. Implicit -source 13 -target 13.
-
-14
+
-14
Set compliance level to 14. Implicit -source 14 -target 14.
-
-15
+
-15
Set compliance level to 15. Implicit -source 15 -target 15.
-
-source 1.1 to 15 (or 8, 8.0, etc.)
+
-source 1.1 to 15 (or 8, 8.0, etc.)
This is used to specify the source level expected by the compiler.
The possible value are:
all missing @Override annotations (superclass and superinterfaces)
+
-
+
allOver-ann
+
all missing @Override annotations (superclass and superinterfaces)
-
-
-
all-static-method
-
all method can be declared as static warnings
+
-
+
all-static-method
+
all method can be declared as static warnings
-
+
-
assertIdentifier
-
occurrence of assert used as identifier
+
+
+
assertIdentifier
+
occurrence of assert used as identifier
-
-
-
boxing
-
autoboxing conversion
+
-
+
boxing
+
autoboxing conversion
-
+
-
charConcat
-
when a char array is used in a string concatenation without being converted explicitly to a string
+
+
+
charConcat
+
when a char array is used in a string concatenation without being converted explicitly to a string
-
+
-
compareIdentical
-
comparing identical expressions
+
+
+
compareIdentical
+
comparing identical expressions
-
-
-
conditionAssign
-
possible accidental boolean assignment
+
-
+
conditionAssign
+
possible accidental boolean assignment
-
+
-
constructorName
-
method with constructor name
+
+
+
constructorName
+
method with constructor name
-
+
-
deadCode
-
dead code excluding trivial if (DEBUG) check
+
+
+
deadCode
+
dead code excluding trivial if (DEBUG) check
-
-
+
-
-
dep-ann
-
missing @Deprecated annotation
+
dep-ann
+
missing @Deprecated annotation
-
+/-
-
deprecation
-
usage of deprecated type or member outside deprecated code
+
+/-
+
deprecation
+
usage of deprecated type or member outside deprecated code
-
+
-
discouraged
+
+
+
discouraged
-
use of types matching a discouraged access rule
+
use of types matching a discouraged access rule
-
-
-
emptyBlock
-
undocumented empty block
+
-
+
emptyBlock
+
undocumented empty block
-
+
-
enumIdentifier
-
occurrence of enum used as identifier
+
+
+
enumIdentifier
+
occurrence of enum used as identifier
-
+
-
enumSwitch
-
incomplete enum switch
+
+
+
enumSwitch
+
incomplete enum switch
-
-
-
enumSwitchPedantic
-
report missing enum switch cases even in the presence of a default case
+
-
+
enumSwitchPedantic
+
report missing enum switch cases even in the presence of a default case
-
-
-
fallthrough
-
possible fall-through case
+
-
+
fallthrough
+
possible fall-through case
-
-
-
fieldHiding
-
field hiding another variable
+
-
+
fieldHiding
+
field hiding another variable
-
+
-
finalBound
-
type parameter with final bound
+
+
+
finalBound
+
type parameter with final bound
-
+
-
finally
-
finally block not completing normally
+
+
+
finally
+
finally block not completing normally
-
+
-
forbidden
-
use of types matching a forbidden access rule
+
+
+
forbidden
+
use of types matching a forbidden access rule
-
-
+
-
-
hashCode
-
missing hashCode() method when overriding equals()
+
hashCode
+
missing hashCode() method when overriding equals()
-
+/-
-
hiding
-
macro for fieldHiding, localHiding, maskedCatchBlock, and typeHiding
+
+/-
+
hiding
+
macro for fieldHiding, localHiding, maskedCatchBlock, and typeHiding
-
-
-
includeAssertNull
-
raise null warnings for variables that got tainted in an assert expression
+
-
+
includeAssertNull
+
raise null warnings for variables that got tainted in an assert expression
-
-
-
indirectStatic
-
indirect reference to static member
+
-
+
indirectStatic
+
indirect reference to static member
-
-
-
inheritNullAnnot
-
consider null annotations as being inherited from an overridden method to any overriding methods
+
-
+
inheritNullAnnot
+
consider null annotations as being inherited from an overridden method to any overriding methods
-
+
-
intfAnnotation
-
annotation type used as super interface
+
+
+
intfAnnotation
+
annotation type used as super interface
-
+
-
intfNonInherited
-
interface non-inherited method compatibility
+
+
+
intfNonInherited
+
interface non-inherited method compatibility
-
-
-
intfRedundant
-
find redundant superinterfaces
+
-
+
intfRedundant
+
find redundant superinterfaces
-
-
-
invalidJavadoc
-
macro to toggle the 'malformed Javadoc comments' option and all its sub-options listed below
+
-
+
invalidJavadoc
+
macro to toggle the 'malformed Javadoc comments' option and all its sub-options listed below
-
-
-
invalidJavadocTag
-
report invalid Javadoc tags in Javadoc comments.
+
-
+
invalidJavadocTag
+
report invalid Javadoc tags in Javadoc comments.
-
-
-
invalidJavadocTagDep
-
report invalid deprecated references in Javadoc tag arguments
+
-
+
invalidJavadocTagDep
+
report invalid deprecated references in Javadoc tag arguments
-
-
-
invalidJavadocTagNotVisible
-
report invalid non-visible references in Javadoc tag arguments
+
-
+
invalidJavadocTagNotVisible
+
report invalid non-visible references in Javadoc tag arguments
-
-
-
invalidJavadocVisibility(<visibility>)
-
specify visibility modifier ("public", "protected" or "private") for malformed Javadoc tag warnings. Usage
+
-
+
invalidJavadocVisibility(<visibility>)
+
specify visibility modifier ("public", "protected" or "private") for malformed Javadoc tag warnings. Usage
example: invalidJavadocVisibility(public)
-
-
-
javadoc
-
invalid Javadoc
+
-
+
javadoc
+
invalid Javadoc
-
-
-
localHiding
-
local variable hiding another variable
+
-
+
localHiding
+
local variable hiding another variable
-
+
-
maskedCatchBlock
-
hidden catch block
+
+
+
maskedCatchBlock
+
hidden catch block
-
-
-
missingJavadocTags
-
macro to toggle the 'missing Javadoc tags' option and all its sub-options listed below
+
-
+
missingJavadocTags
+
macro to toggle the 'missing Javadoc tags' option and all its sub-options listed below
-
-
-
missingJavadocTagsMethod
-
report missing Javadoc tags for a method's type parameters
+
-
+
missingJavadocTagsMethod
+
report missing Javadoc tags for a method's type parameters
-
-
-
missingJavadocTagsOverriding
-
report missing Javadoc tags in overriding methods
+
-
+
missingJavadocTagsOverriding
+
report missing Javadoc tags in overriding methods
-
-
-
missingJavadocTagsVisibility(<visibility>)
-
specify visibility modifier ("public", "protected" or "private") for missing Javadoc tags warnings. Usage
+
-
+
missingJavadocTagsVisibility(<visibility>)
+
specify visibility modifier ("public", "protected" or "private") for missing Javadoc tags warnings. Usage
example: missingJavadocTagsVisibility(public)
-
-
-
missingJavadocComments
-
macro to toggle the 'missing Javadoc comments' option and all its sub-options listed below
+
-
+
missingJavadocComments
+
macro to toggle the 'missing Javadoc comments' option and all its sub-options listed below
-
-
-
missingJavadocCommentsOverriding
-
report missing Javadoc comments in overriding methods
+
-
+
missingJavadocCommentsOverriding
+
report missing Javadoc comments in overriding methods
-
-
-
missingJavadocCommentsVisibility(<visibility>)
-
specify visibility modifier ("public", "protected" or "private") for missing Javadoc comments warnings. Usage
+
-
+
missingJavadocCommentsVisibility(<visibility>)
+
specify visibility modifier ("public", "protected" or "private") for missing Javadoc comments warnings. Usage
example: missingJavadocCommentsVisibility(public)
-
-
-
nls
-
non-nls string literals (lacking of tags //$NON-NLS-<n>)
+
-
+
nls
+
non-nls string literals (lacking of tags //$NON-NLS-<n>)
-
+
-
noEffectAssign
-
assignment with no effect
+
+
+
noEffectAssign
+
assignment with no effect
-
+
-
nonnullNotRepeated
-
nonnull parameter annotation from overridden method is not repeated in an overriding method. Is effective only with the nullAnnot option enabled.
+
+
+
nonnullNotRepeated
+
nonnull parameter annotation from overridden method is not repeated in an overriding method. Is effective only with the nullAnnot option enabled.
-
+/-
-
null
-
potential missing or redundant null check
+
+/-
+
null
+
potential missing or redundant null check
-
-
-
nullAnnot
-
enable annotation based null analysis.
+
-
+
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.
@@ -696,264 +694,264 @@
Which Options Are Available?
-
-
-
nullAnnotConflict
-
report conflicts between null annotation specified and nullness inferred. Is effective
+
-
+
nullAnnotConflict
+
report conflicts between null annotation specified and nullness inferred. Is effective
only with the nullAnnot option enabled.
-
-
-
nullAnnotRedundant
-
report redundant specification of null annotation. Is effective
+
-
+
nullAnnotRedundant
+
report redundant specification of null annotation. Is effective
only with the nullAnnot option enabled.
-
-
-
nullDereference
-
missing null check
+
-
+
nullDereference
+
missing null check
-
-
-
nullUncheckedConversion
-
report unchecked conversion from unannotated type to @NonNull type. Is effective
+
-
+
nullUncheckedConversion
+
report unchecked conversion from unannotated type to @NonNull type. Is effective
only with the nullAnnot option enabled.
-
-
-
over-ann
-
missing @Override annotation (superclass only)
+
-
+
over-ann
+
missing @Override annotation (superclass only)
-
-
-
paramAssign
-
assignment to a parameter
+
-
+
paramAssign
+
assignment to a parameter
-
+
-
pkgDefaultMethod
-
attempt to override package-default method
+
+
+
pkgDefaultMethod
+
attempt to override package-default method
-
+
-
raw
-
usage a of raw type (instead of a parameterized type)
+
+
+
raw
+
usage a of raw type (instead of a parameterized type)
-
+/-
-
resource
-
(potentially) unsafe usage of resource of type Closeable
+
+/-
+
resource
+
(potentially) unsafe usage of resource of type Closeable
-
-
-
semicolon
+
-
+
semicolon
-
unnecessary semicolon or empty statement
+
unnecessary semicolon or empty statement
-
+
-
serial
-
missing serialVersionUID
+
+
+
serial
+
missing serialVersionUID
-
-
-
specialParamHiding
-
constructor or setter parameter hiding another field
+
-
+
specialParamHiding
+
constructor or setter parameter hiding another field
-
+/-
-
static-access
-
macro for indirectStatic and staticReceiver
+
+/-
+
static-access
+
macro for indirectStatic and staticReceiver
-
-
-
static-method
-
an instance method that could be as a static method
+
-
+
static-method
+
an instance method that could be as a static method
-
+
-
staticReceiver
-
if a non static receiver is used to get a static field or call a static method
+
+
+
staticReceiver
+
if a non static receiver is used to get a static field or call a static method
-
-
-
super
-
overriding a method without making a super invocation
+
-
+
super
+
overriding a method without making a super invocation
-
+
-
suppress
-
enable @SuppressWarnings
+
+
+
suppress
+
enable @SuppressWarnings
-
-
-
switchDefault
-
switch statement lacking a default case
+
-
+
switchDefault
+
switch statement lacking a default case
-
-
-
syncOverride
-
missing synchronized in synchronized method override
+
-
+
syncOverride
+
missing synchronized in synchronized method override
-
-
-
syntacticAnalysis
-
perform syntax-based null analysis for fields
+
-
+
syntacticAnalysis
+
perform syntax-based null analysis for fields
-
-
-
syntheticAccess
-
when performing synthetic access for innerclass
+
-
+
syntheticAccess
+
when performing synthetic access for innerclass
-
-
-
tasks
-
enable support for tasks tags in source code
+
-
+
tasks
+
enable support for tasks tags in source code
-
+
-
typeHiding
-
type parameter hiding another type
+
+
+
typeHiding
+
type parameter hiding another type
-
+
-
unavoidableGenericProblems
-
report even unavoidable type safety problems due to raw APIs
+
+
+
unavoidableGenericProblems
+
report even unavoidable type safety problems due to raw APIs
-
+
-
unchecked
-
unchecked type operation
+
+
+
unchecked
+
unchecked type operation
-
-
-
unnecessaryElse
-
unnecessary else clause
+
-
+
unnecessaryElse
+
unnecessary else clause
-
-
-
unqualifiedField
-
unqualified reference to field
+
-
+
unqualifiedField
+
unqualified reference to field
-
+/-
-
unused
-
macro for deadCode, intfRedundant, unusedAllocation, unusedExceptionParam, unusedImport, unusedLabel, unusedLocal, unusedParam, unusedPrivate, unusedThrown, unusedTypeArgs, and unusedTypeParameter
+
+/-
+
unused
+
macro for deadCode, intfRedundant, unusedAllocation, unusedExceptionParam, unusedImport, unusedLabel, unusedLocal, unusedParam, unusedPrivate, unusedThrown, unusedTypeArgs, and unusedTypeParameter
-
-
-
unusedAllocation
-
allocating an object that is not used
+
-
+
unusedAllocation
+
allocating an object that is not used
-
-
-
unusedArgument
-
unused method parameter (deprecated option; use unusedParam instead)
+
-
+
unusedArgument
+
unused method parameter (deprecated option; use unusedParam instead)
-
+
-
unusedImport
-
unused import reference
+
+
+
unusedImport
+
unused import reference
-
+
-
unusedLabel
-
unused label
+
+
+
unusedLabel
+
unused label
-
+
-
unusedLocal
-
unused local variable
+
+
+
unusedLocal
+
unused local variable
-
+
-
unusedParam
-
unused method parameter
+
+
+
unusedParam
+
unused method parameter
-
+
-
unusedParamImplementing
-
unused parameter for implementing method
+
+
+
unusedParamImplementing
+
unused parameter for implementing method
-
+
-
unusedParamIncludeDoc
-
unused parameter documented in a Javadoc comment tag
+
+
+
unusedParamIncludeDoc
+
unused parameter documented in a Javadoc comment tag
-
+
-
unusedParamOverriding
-
unused parameter for overriding method
+
+
+
unusedParamOverriding
+
unused parameter for overriding method
-
+
-
unusedPrivate
-
unused private member declaration
+
+
+
unusedPrivate
+
unused private member declaration
-
-
-
unusedThrown
-
unused declared thrown exception
+
-
+
unusedThrown
+
unused declared thrown exception
-
-
-
unusedThrownIncludeDocComment
-
unused declared thrown exception documented in a Javadoc comment tag
+
-
+
unusedThrownIncludeDocComment
+
unused declared thrown exception documented in a Javadoc comment tag
-
-
-
unusedThrownExemptExceptionThrowable
-
report unused declared thrown exception but exempt Exception and Throwable
+
-
+
unusedThrownExemptExceptionThrowable
+
report unused declared thrown exception but exempt Exception and Throwable
-
-
-
unusedThrownWhenOverriding
-
unused declared thrown exception in overriding method
+
-
+
unusedThrownWhenOverriding
+
unused declared thrown exception in overriding method
-
+
-
unusedTypeArgs
-
unused type arguments for method and constructor
+
+
+
unusedTypeArgs
+
unused type arguments for method and constructor
-
+
-
unusedTypeParameter
-
unused type parameter
+
+
+
unusedTypeParameter
+
unused type parameter
-
-
-
uselessTypeCheck
-
unnecessary cast/instanceof operation
+
-
+
uselessTypeCheck
+
unnecessary cast/instanceof operation
-
+
-
varargsCast
-
varargs argument need explicit cast
+
+
+
varargsCast
+
varargs argument need explicit cast
-
+/-
-
warningToken
-
unhandled or unused warning token in @SuppressWarnings
+
+/-
+
warningToken
+
unhandled or unused warning token in @SuppressWarnings
-
-nowarn
+
-nowarn
No warning (equivalent to -warn:none)
-
-err:...
-
Specify the set of enabled warnings that are converted to errors.
+
-err:...
+
Specify the set of enabled warnings that are converted to errors.
e.g. -err:unusedLocal,deprecation
unusedLocal and deprecation warnings will be converted to errors. All other warnings are still reported as warnings.
@@ -975,8 +973,8 @@
Which Options Are Available?
-
-info:...
-
Specify the set of enabled warnings that are converted to infos.
+
-info:...
+
Specify the set of enabled warnings that are converted to infos.
e.g. -info:unusedLocal,deprecation
unusedLocal and deprecation warnings will be converted to infos. All other warnings are still reported as warnings.
@@ -998,11 +996,11 @@
Which Options Are Available?
-
-deprecation
+
-deprecation
Equivalent to -warn:+deprecation.
-
-properties <file>
+
-properties <file>
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
@@ -1030,21 +1028,21 @@
Which Options Are Available?
Debug options
-
-g[:none|:lines,vars,source]
+
-g[:none|:lines,vars,source]
Set the debug attributes level
-
-g
+
-g
-
All debug info (equivalent to -g:lines,vars,source)
+
All debug info (equivalent to -g:lines,vars,source)
-
-g:none
-
No debug info
+
-g:none
+
No debug info
-
-g:[lines,vars,source]
-
Selective debug info
+
-g:[lines,vars,source]
+
Selective debug info
@@ -1052,11 +1050,11 @@
Which Options Are Available?
-
-preserveAllLocals
+
-preserveAllLocals
Explicitly request the compiler to preserve all local variables (for debug purpose). If omitted, the compiler will remove unused locals.
-
-parameters
+
-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.
@@ -1064,89 +1062,89 @@
Which Options Are Available?
Annotation processing options (require a 1.6 VM or above and are used only if the compliance is 1.6)
-
-Akey[=value]
-
Annotation processors options that are passed to annotation processors. key is made of identifiers separated by dots
+
-Akey[=value]
+
Annotation processors options that are passed to annotation processors. key is made of identifiers separated by dots
-
-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
+
-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.
Qualified class names of annotation processors to run. If specified, the normal processor discovery process will be skipped.
-
-processorpath <dir 1>;<dir 2>;...;<dir P>
+
-processorpath <dir 1>;<dir 2>;...;<dir P>
-
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
+
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.
-
-s <dir>
-
The directory where generated source files will be created.
+
-s <dir>
+
The directory where generated source files will be created.
-
-XprintProcessorInfo
-
Print information about which annotations and which elements a processor is asked to process
+
-XprintProcessorInfo
+
Print information about which annotations and which elements a processor is asked to process
-
-XprintRounds
-
Print information about annotation processing rounds
+
-XprintRounds
+
Print information about annotation processing rounds
-
-classNames <class1[,class2,...]>
-
Qualified names of binary types that need to be processed
+
-classNames <class1[,class2,...]>
+
Qualified names of binary types that need to be processed
Ignored options (for compatibility with javac options)
-
-J<option>
-
Pass option to the virtual machine
+
-J<option>
+
Pass option to the virtual machine
-
-X<option>
-
Specify non-standard option. -Xemacs is not ignored.
+
-X<option>
+
Specify non-standard option. -Xemacs is not ignored.
-
-X
-
Print non-standard options and exit
+
-X
+
Print non-standard options and exit
-
-O
-
Optimize for execution time
+
-O
+
Optimize for execution time
Advanced options
-
@<file>
-
Read command-line arguments from file
+
@<file>
+
Read command-line arguments from file
-
-maxProblems <n>
-
Max number of problems per compilation unit (100 by default)
+
-maxProblems <n>
+
Max number of problems per compilation unit (100 by default)
-
-log <filename>
+
-log <filename>
Specify a log file in which all output from the compiler will be dumped. This is really useful if you want to debug the batch compiler or get a file which contains all errors and
warnings from a batch build. If the extension is .xml, the generated log will be an xml file.
-
-genericsignature
+
-genericsignature
Explicitly request the compiler to preserve information about generic signature of lambda expressions.
-
-Xemacs
+
-Xemacs
Use emacs style to present errors and warnings locations into the console and regular text logs. XML logs are unaffected by this option. With this option active, the message: 2. WARNING in /workspace/X.java
(at line 8)...
@@ -1154,7 +1152,7 @@
Which Options Are Available?
/workspace/X.java:8: warning: The method...
-
-proceedOnError[:Fatal]
+
-proceedOnError[:Fatal]
Keep compiling in spite of errors, dumping class files with problem methods or problem types. This is recommended only if you want to be able to run your application even if you have
remaining errors.
@@ -1162,52 +1160,52 @@
Which Options Are Available?
generation and the produced .class files can be run without a problem.
-
-failOnWarning
+
-failOnWarning
Declare compilation unsuccessfull if there are warnings by calling System.exit(-1) at end of compilation.
-
-verbose
+
-verbose
Print accessed/processed compilation units in the console or the log file if specified.
-
-referenceInfo
+
-referenceInfo
Compute reference info. This is useful only if connected to the builder. The reference infos are useless otherwise.
-
-progress
+
-progress
Show progress (only in -log mode).
-
-time
+
-time
Display speed information.
-
-noExit
+
-noExit
Do not call System.exit(n) at end of compilation (n=0 if no error).
-
-repeat <n>
+
-repeat <n>
Repeat compilation process <n> times (perf analysis).
-
-inlineJSR
+
-inlineJSR
Inline JSR bytecode (implicit if target >= 1.5).
-
-enableJavadoc
+
-enableJavadoc
Consider references inside Javadoc. The Javadoc options are effective only when this option is enabled.
-
-missingNullDefault
+
-missingNullDefault
When annotation based null analysis is enabled (using "nullAnnot", above), this option
will raise a warning whenever there is no default annotation on a package or a type.
-
-annotationpath
+
-annotationpath
When annotation based null analysis is enabled (using "nullAnnot", above), this option
defines locations where to find external annotations to support annotation-based null analysis.
The value of this options is a list of directories or zip files. Entries are separated by the platform path separator.
@@ -1217,16 +1215,16 @@
Which Options Are Available?
Helping options
-
-? -help
-
Display the help message.
+
-? -help
+
Display the help message.
-
-v -version
+
-v -version
Display the build number of the compiler. This is very useful to report a bug.
-
-showversion
+
-showversion
Display the build number of the compiler and continue. This is very useful to report a bug.
@@ -1234,13 +1232,13 @@
Examples
-
d:\temp -classpath rt.jar -time -g -d d:/tmp
-
It compiles all source files in d:\temp and its subfolders. The classpath is simply rt.jar. It generates all debug attributes and all generated .class files are dumped in d:\tmp. The
+
d:\temp -classpath rt.jar -time -g -d d:/tmp
+
It compiles all source files in d:\temp and its subfolders. The classpath is simply rt.jar. It generates all debug attributes and all generated .class files are dumped in d:\tmp. The
speed of the compiler will be displayed once the batch process is completed.
It compiles only Test.java and its dependant files if any, retrieving dependant files from d:\temp. The classpath is d:\temp followed by rt.jar, which means that all necessary
+
It compiles only Test.java and its dependant files if any, retrieving dependant files from d:\temp. The classpath is d:\temp followed by rt.jar, which means that all necessary
classes are searched first in d:\temp and then in rt.jar. It generates no debug attributes and all generated .class files are dumped in d:\temp.
As a consequence, the notation for canceling a default from an outer scope has been changed, too:
-
+
+
Cancelling a default
Declaration Annotations (Java 7 or below)
Type Annotation (Java 8)
@NonNullByDefault(false)
@NonNullByDefault({})
@@ -497,7 +498,7 @@
Compiler Messages Explained
General Null Type Mismatch
-
Null type mismatch (type annotations): required 'X' but this expression has type 'Y'
+
Null type mismatch (type annotations): required 'X' but this expression has type 'Y'
In an assignment context null type annotations don't match.
Note that the mismatch may relate to any detail of the type (type argument, array element), not necessarily to the main type.
@@ -507,40 +508,40 @@
General Null Type Mismatch
Various Expressions
-
Potential null pointer access: array element may be null
+
Potential null pointer access: array element may be null
An array element is dereferenced, where the array type declares its elements as @Nullable.
-
Potential null pointer access: this expression has a '@Nullable' type
+
Potential null pointer access: this expression has a '@Nullable' type
Any expression at the left hand side of a dot has a type that is declared to be nullable.
-
Redundant null check: comparing '@NonNull X' against null
+
Redundant null check: comparing '@NonNull X' against null
An arbitrary expression known to have a @NonNull type is unnecessarily being compared against null.
Unchecked Conversions
-
Null type safety (type annotations): The expression of type 'X' needs unchecked conversion to conform to '@NonNull X'
+
Null type safety (type annotations): The expression of type 'X' needs unchecked conversion to conform to '@NonNull X'
A value of an un-annotated type is being assigned to a variable of an annotated type.
Note that the mismatch may relate to any detail of the type (type argument, array element), not necessarily to the main type.
-
Null type safety: Unchecked cast from X to '@N Y'
+
Null type safety: Unchecked cast from X to '@N Y'
A value is casted to a null-annotated type, where the nullness is not checked at runtime by the cast.
Problems Specific to Generics
-
Null constraint mismatch: The type 'X' is not a valid substitute for the type parameter 'T'
+
Null constraint mismatch: The type 'X' is not a valid substitute for the type parameter 'T'
Here the type parameter <T> has a constraint in one of the forms mentioned above.
The actual type argument X, however, doesn't conform to this constraint.
-
This nullness annotation conflicts with a '@N' annotation which is effective on the same type parameter
+
This nullness annotation conflicts with a '@N' annotation which is effective on the same type parameter
A null annotation on a bound of a type parameter conflicts with another null annotation on another bound or on the type parameter itself.
-
Contradictory null annotations: method was inferred as 'T foo(X)', but only one of '@NonNull' and '@Nullable' can be effective at any location
+
Contradictory null annotations: method was inferred as 'T foo(X)', but only one of '@NonNull' and '@Nullable' can be effective at any location
Type inference for a generic method invocation has produced a signature in which contradictory null annotations clash on the same element.
-
Null type mismatch (type annotations): 'null' is not compatible to the free type variable 'T'
-
Null type mismatch (type annotations): required 'T' but this expression has type '@Nullable T', where 'T' is a free type variable
-
Null type safety: required '@NonNull' but this expression has type 'T', a free type variable that may represent a '@Nullable' type
-
The field 'f' may not have been initialized, whereas its type 'T' is a free type variable that may represent a '@NonNull' type
-
Potential null pointer access: this expression has type 'T', a free type variable that may represent a '@Nullable' type
+
Null type mismatch (type annotations): 'null' is not compatible to the free type variable 'T'
+
Null type mismatch (type annotations): required 'T' but this expression has type '@Nullable T', where 'T' is a free type variable
+
Null type safety: required '@NonNull' but this expression has type 'T', a free type variable that may represent a '@Nullable' type
+
The field 'f' may not have been initialized, whereas its type 'T' is a free type variable that may represent a '@NonNull' type
+
Potential null pointer access: this expression has type 'T', a free type variable that may represent a '@Nullable' type
Unsafe interpretation of method return type as '@NonNull X' based on the receiver type 'Map<Y,@NonNull X>'. Type 'Map' doesn't seem to be designed with null type annotations in mind
-
Unsafe interpretation of method return type as '@NonNull X' based on substitution 'V=@NonNull X'. Declaring type 'Map<K,V>' doesn't seem to be designed with null type annotations in mind
+
Unsafe interpretation of method return type as '@NonNull X' based on the receiver type 'Map<Y,@NonNull X>'. Type 'Map' doesn't seem to be designed with null type annotations in mind
+
Unsafe interpretation of method return type as '@NonNull X' based on substitution 'V=@NonNull X'. Declaring type 'Map<K,V>' doesn't seem to be designed with null type annotations in mind
When invoked on MacOS, the paths to point to the configuration file or the source files can be relative, but they will be computed
from the location of the eclipse.ini file. This is a limitation of the Eclipse launcher on MacOS. On all other platforms, the relative paths
are computed relative to the current user directory.
-
+
-
+
-data <workspace>
-
+
The formatter requires a workspace to run. The workspace folder does
not have to exist and can be removed after the formatter is complete.
@@ -46,7 +44,7 @@
-
+
<files>
@@ -56,7 +54,7 @@
-
+
@@ -75,12 +73,12 @@
-
+
-config <file>
-
+
Use the formatting style from the specified properties file.
@@ -90,26 +88,26 @@
-
+
-help
-
+
Display the help message.
-
+
-quiet
-
+
Only print error messages.
@@ -117,12 +115,12 @@
-
+
-verbose
-
+
Be verbose about the formatting job.
diff --git a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-232.htm b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-232.htm
index acf34ef435b..59c6c597152 100644
--- a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-232.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-232.htm
@@ -1,15 +1,13 @@
-
-
+
+
-
-
+
Generating a Config File for the Formatter Application
-
diff --git a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-32.htm b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-32.htm
index 4e3584ff09c..eb634479847 100644
--- a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-32.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-32.htm
@@ -1,12 +1,10 @@
-
-
+
+
-
-
-
+
Creating JAR Files
diff --git a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-33.htm b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-33.htm
index 7febfced8c8..100382e1014 100644
--- a/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-33.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/tasks/tasks-33.htm
@@ -1,14 +1,13 @@
-
+
-
-
+
Creating a New JAR File
-
-
+
+