Modifier and Type	Class and Description
public static enum	Lint.LintCategory Categories of warnings that can be generated by the compiler.

Modifier and Type	Field and Description
private final Context	context
protected static final Context.Key<Lint>	lintKey The context key for the root Lint object.
private final Log	log
private Names	names
private final Options	options
private EnumSet<Lint.LintCategory>	suppressedValues
private Symtab	syms
private EnumSet<Lint.LintCategory>	values
private boolean	withinDeprecated

Access	Constructor and Description
protected	Lint(Context context)
protected	Lint(Lint other)

Modifier and Type	Method and Description
public Lint	Returns: lint instance with new warning suppressions applied, or this instance if none augment(Symbol symbol sym) Obtain an instance with additional warning supression applied from any
private EnumSet<Lint.LintCategory>	getDefaults()
private void	initializeRootIfNeeded()
private void	initializeSymbolsIfNeeded()
public static Lint	instance(Context context) Get the root Lint instance.
public static boolean	isDeprecatedDeclaration(Symbol sym)
public boolean	isEnabled(Lint.LintCategory lc) Checks if a warning category is enabled.
public boolean	isSuppressed(Lint.LintCategory lc) Check if a warning category has been specifically suppressed by means of @SuppressWarnings.
public boolean	shouldEmit(JCDiagnostic diag) Determine if the given diagnostic should be emitted given the state of this instance.
public EnumSet<Lint.LintCategory>	Returns: new warning suppressions applied to sym suppressionsFrom(Symbol symbol corresponding to a possibly-annotated declaration symbol) Obtain the set of recognized lint warning categories suppressed at the given symbol's declaration.
private EnumSet<Lint.LintCategory>	suppressionsFrom(Stream<Attribute.Compound> attributes)
private EnumSet<Lint.LintCategory>	suppressionsFrom(Attribute.Compound suppressWarnings)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

context	back to summary
private final Context context

lintKey	back to summary
protected static final Context.Key<Lint> lintKey The context key for the root Lint object.

log	back to summary
private final Log log

names	back to summary
private Names names

options	back to summary
private final Options options

suppressedValues	back to summary
private EnumSet<Lint.LintCategory> suppressedValues

syms	back to summary
private Symtab syms

values	back to summary
private EnumSet<Lint.LintCategory> values

withinDeprecated	back to summary
private boolean withinDeprecated

Lint	back to summary
protected Lint(Context context) Annotations @SuppressWarnings:this-escape

Lint	back to summary
protected Lint(Lint other)

augment	back to summary
public Lint augment(Symbol sym) Obtain an instance with additional warning supression applied from any Parameters sym:Symbol symbol Returns:Lint lint instance with new warning suppressions applied, or this instance if none

getDefaults	back to summary
private EnumSet<Lint.LintCategory> getDefaults()

initializeRootIfNeeded	back to summary
private void initializeRootIfNeeded()

initializeSymbolsIfNeeded	back to summary
private void initializeSymbolsIfNeeded()

instance	back to summary
public static Lint instance(Context context) Get the root Lint instance.

isDeprecatedDeclaration	back to summary
public static boolean isDeprecatedDeclaration(Symbol sym)

isEnabled	back to summary
public boolean isEnabled(Lint.LintCategory lc) Checks if a warning category is enabled. A warning category may be enabled on the command line, or by default, and can be temporarily disabled with the SuppressWarnings annotation.

isSuppressed	back to summary
public boolean isSuppressed(Lint.LintCategory lc) Check if a warning category has been specifically suppressed by means of @SuppressWarnings. Always returns false for categories that are not suppressible by the annotation, even if they (uselessly) happen to appear in one.

shouldEmit	back to summary
public boolean shouldEmit(JCDiagnostic diag) Determine if the given diagnostic should be emitted given the state of this instance.

suppressionsFrom	back to summary
public EnumSet<Lint.LintCategory> suppressionsFrom(Symbol symbol) Obtain the set of recognized lint warning categories suppressed at the given symbol's declaration. This set can be non-empty only if the symbol is annotated with @SuppressWarnings, and only categories for which `annotationSuppression` is true are included. Parameters symbol:Symbol symbol corresponding to a possibly-annotated declaration Returns:EnumSet<Lint.LintCategory> new warning suppressions applied to sym

suppressionsFrom	back to summary
private EnumSet<Lint.LintCategory> suppressionsFrom(Stream<Attribute.Compound> attributes)

suppressionsFrom	back to summary
private EnumSet<Lint.LintCategory> suppressionsFrom(Attribute.Compound suppressWarnings)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

com.sun.tools.javac.code back to summary

public final Enum Lint.LintCategory

Class Inheritance

java.lang.Object
java.lang.Enum
com.sun.tools.javac.code.Lint.LintCategory

Categories of warnings that can be generated by the compiler. Each lint category has a logical name (a string), which is the string used e.g. in a SuppressWarning annotation. To ensure automation, the enum field name for a lint category string C should be obtained by:

capitalize all the letters in C, and
replacing any occurrence of - with _

For instance, the lint category string dangling-doc-comments corresponds to the enum field DANGLING_DOC_COMMENTS.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static enum	Lint.LintCategory.Property

Field Summary

Modifier and Type	Field and Description
public final boolean	annotationSuppression Does this category support being suppressed by the `@SuppressWarnings` annotation?
public static final Lint.LintCategory	AUXILIARYCLASS Warn when code refers to a auxiliary class that is hidden in a source file (ie source file name is different from the class name, and the type is not properly nested) and the referring code is not located in the same source file.
public static final Lint.LintCategory	CAST Warn about use of unnecessary casts.
public static final Lint.LintCategory	CLASSFILE Warn about issues related to classfile contents.
public static final Lint.LintCategory	DANGLING_DOC_COMMENTS Warn about "dangling" documentation comments, not attached to any declaration.
public static final Lint.LintCategory	DEP_ANN Warn about items which are documented with an `@deprecated` JavaDoc comment, but which do not have `@Deprecated` annotation.
public static final Lint.LintCategory	DEPRECATION Warn about use of deprecated items.
public static final Lint.LintCategory	DIVZERO Warn about division by constant integer 0.
public static final Lint.LintCategory	EMPTY Warn about empty statement after if.
public final boolean	enabledByDefault Is this category included in the default set of enabled lint categories?
public static final Lint.LintCategory	EXPORTS Warn about issues regarding module exports.
public static final Lint.LintCategory	FALLTHROUGH Warn about falling through from one case of a switch statement to the next.
public static final Lint.LintCategory	FINALLY Warn about finally clauses that do not terminate normally.
public static final Lint.LintCategory	IDENTITY Warn about uses of @ValueBased classes where an identity class is expected.
public static final Lint.LintCategory	INCUBATING Warn about use of incubating modules.
private static final SequencedMap<String, Lint.LintCategory>	lookup
public static final Lint.LintCategory	LOSSY_CONVERSIONS Warn about compiler possible lossy conversions.
public static final Lint.LintCategory	MISSING_EXPLICIT_CTOR Warn about compiler generation of a default constructor.
public static final Lint.LintCategory	MODULE Warn about module system related issues.
public static final Lint.LintCategory	OPENS Warn about issues regarding module opens.
public final String	option Get the "canonical" string representing this category in @SuppressAnnotations and -Xlint options.
public final List<String>	optionList Get a list containing "option" followed by zero or more aliases.
public static final Lint.LintCategory	OPTIONS Warn about issues relating to use of command line options.
public static final Lint.LintCategory	OUTPUT_FILE_CLASH Warn when any output file is written to more than once.
public static final Lint.LintCategory	OVERLOADS Warn about issues regarding method overloads.
public static final Lint.LintCategory	OVERRIDES Warn about issues regarding method overrides.
public static final Lint.LintCategory	PATH Warn about invalid path elements on the command line.
public static final Lint.LintCategory	PREVIEW Warn about use of preview features.
public static final Lint.LintCategory	PROCESSING Warn about issues regarding annotation processing.
public static final Lint.LintCategory	RAWTYPES Warn about unchecked operations on raw types.
public static final Lint.LintCategory	REMOVAL Warn about use of deprecated-for-removal items.
public static final Lint.LintCategory	REQUIRES_AUTOMATIC Warn about use of automatic modules in the requires clauses.
public static final Lint.LintCategory	REQUIRES_TRANSITIVE_AUTOMATIC Warn about automatic modules in requires transitive.
public static final Lint.LintCategory	RESTRICTED Warn about use of restricted methods.
public static final Lint.LintCategory	SERIAL Warn about Serializable classes that do not provide a serial version ID.
public static final Lint.LintCategory	STATIC Warn about issues relating to use of statics
public static final Lint.LintCategory	STRICTFP Warn about unnecessary uses of the strictfp modifier
public static final Lint.LintCategory	TEXT_BLOCKS Warn about issues relating to use of text blocks
public static final Lint.LintCategory	THIS_ESCAPE Warn about possible 'this' escapes before subclass instance is fully initialized.
public static final Lint.LintCategory	TRY Warn about issues relating to use of try blocks (i.e. try-with-resources)
public static final Lint.LintCategory	UNCHECKED Warn about unchecked operations on raw types.
public static final Lint.LintCategory	VARARGS Warn about potentially unsafe vararg methods

Constructor Summary

Access	Constructor and Description
private	LintCategory(String option, Lint.LintCategory.Property... properties)
private	LintCategory(List<String> options, Lint.LintCategory.Property... properties)

Method Summary

Modifier and Type	Method and Description
private static SequencedMap<String, Lint.LintCategory>	createLookup()
public static Optional<Lint.LintCategory>	Returns: corresponding `LintCategory`, or empty if none exists get(String lint category option string option) Get the `LintCategory` having the given command line option.
public static EnumSet<Lint.LintCategory>	newEmptySet()
public static SequencedSet<String>	options() Get all lint category option strings and aliases.
public static Lint.LintCategory	valueOf(String name)
public static Lint.LintCategory[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

annotationSuppression	back to summary
public final boolean annotationSuppression Does this category support being suppressed by the `@SuppressWarnings` annotation?

AUXILIARYCLASS	back to summary
public static final Lint.LintCategory AUXILIARYCLASS Warn when code refers to a auxiliary class that is hidden in a source file (ie source file name is different from the class name, and the type is not properly nested) and the referring code is not located in the same source file.

CAST	back to summary
public static final Lint.LintCategory CAST Warn about use of unnecessary casts.

CLASSFILE back to summary

CLASSFILE	back to summary
public static final Lint.LintCategory CLASSFILE Warn about issues related to classfile contents. This category is not supported by `@SuppressWarnings`.

public static final Lint.LintCategory CLASSFILE

Warn about issues related to classfile contents.

This category is not supported by @SuppressWarnings.

DANGLING_DOC_COMMENTS	back to summary
public static final Lint.LintCategory DANGLING_DOC_COMMENTS Warn about "dangling" documentation comments, not attached to any declaration.

DEP_ANN	back to summary
public static final Lint.LintCategory DEP_ANN Warn about items which are documented with an `@deprecated` JavaDoc comment, but which do not have `@Deprecated` annotation.

DEPRECATION	back to summary
public static final Lint.LintCategory DEPRECATION Warn about use of deprecated items.

DIVZERO	back to summary
public static final Lint.LintCategory DIVZERO Warn about division by constant integer 0.

EMPTY	back to summary
public static final Lint.LintCategory EMPTY Warn about empty statement after if.

enabledByDefault	back to summary
public final boolean enabledByDefault Is this category included in the default set of enabled lint categories? Note that for some categories, command line options can alter this at runtime.

EXPORTS	back to summary
public static final Lint.LintCategory EXPORTS Warn about issues regarding module exports.

FALLTHROUGH	back to summary
public static final Lint.LintCategory FALLTHROUGH Warn about falling through from one case of a switch statement to the next.

FINALLY	back to summary
public static final Lint.LintCategory FINALLY Warn about finally clauses that do not terminate normally.

IDENTITY	back to summary
public static final Lint.LintCategory IDENTITY Warn about uses of @ValueBased classes where an identity class is expected.

INCUBATING back to summary

INCUBATING	back to summary
public static final Lint.LintCategory INCUBATING Warn about use of incubating modules. This category is not supported by `@SuppressWarnings`.

public static final Lint.LintCategory INCUBATING

Warn about use of incubating modules.

This category is not supported by @SuppressWarnings.

lookup	back to summary
private static final SequencedMap<String, Lint.LintCategory> lookup

LOSSY_CONVERSIONS	back to summary
public static final Lint.LintCategory LOSSY_CONVERSIONS Warn about compiler possible lossy conversions.

MISSING_EXPLICIT_CTOR	back to summary
public static final Lint.LintCategory MISSING_EXPLICIT_CTOR Warn about compiler generation of a default constructor.

MODULE	back to summary
public static final Lint.LintCategory MODULE Warn about module system related issues.

OPENS	back to summary
public static final Lint.LintCategory OPENS Warn about issues regarding module opens.

option	back to summary
public final String option Get the "canonical" string representing this category in @SuppressAnnotations and -Xlint options.

optionList	back to summary
public final List<String> optionList Get a list containing "option" followed by zero or more aliases.

OPTIONS back to summary

public static final Lint.LintCategory OPTIONS

Warn about issues relating to use of command line options.

This category is not supported by @SuppressWarnings.

OUTPUT_FILE_CLASH back to summary

public static final Lint.LintCategory OUTPUT_FILE_CLASH

Warn when any output file is written to more than once.

This category is not supported by @SuppressWarnings.

OVERLOADS	back to summary
public static final Lint.LintCategory OVERLOADS Warn about issues regarding method overloads.

OVERRIDES	back to summary
public static final Lint.LintCategory OVERRIDES Warn about issues regarding method overrides.

PATH back to summary

public static final Lint.LintCategory PATH

Warn about invalid path elements on the command line.

This category is not supported by @SuppressWarnings.

PREVIEW	back to summary
public static final Lint.LintCategory PREVIEW Warn about use of preview features.

PROCESSING back to summary

public static final Lint.LintCategory PROCESSING

Warn about issues regarding annotation processing.

This category is not supported by @SuppressWarnings.

RAWTYPES	back to summary
public static final Lint.LintCategory RAWTYPES Warn about unchecked operations on raw types.

REMOVAL	back to summary
public static final Lint.LintCategory REMOVAL Warn about use of deprecated-for-removal items.

REQUIRES_AUTOMATIC	back to summary
public static final Lint.LintCategory REQUIRES_AUTOMATIC Warn about use of automatic modules in the requires clauses.

REQUIRES_TRANSITIVE_AUTOMATIC	back to summary
public static final Lint.LintCategory REQUIRES_TRANSITIVE_AUTOMATIC Warn about automatic modules in requires transitive.

RESTRICTED	back to summary
public static final Lint.LintCategory RESTRICTED Warn about use of restricted methods.

SERIAL	back to summary
public static final Lint.LintCategory SERIAL Warn about Serializable classes that do not provide a serial version ID.

STATIC	back to summary
public static final Lint.LintCategory STATIC Warn about issues relating to use of statics

STRICTFP	back to summary
public static final Lint.LintCategory STRICTFP Warn about unnecessary uses of the strictfp modifier

TEXT_BLOCKS	back to summary
public static final Lint.LintCategory TEXT_BLOCKS Warn about issues relating to use of text blocks

THIS_ESCAPE	back to summary
public static final Lint.LintCategory THIS_ESCAPE Warn about possible 'this' escapes before subclass instance is fully initialized.

TRY	back to summary
public static final Lint.LintCategory TRY Warn about issues relating to use of try blocks (i.e. try-with-resources)

UNCHECKED	back to summary
public static final Lint.LintCategory UNCHECKED Warn about unchecked operations on raw types.

VARARGS	back to summary
public static final Lint.LintCategory VARARGS Warn about potentially unsafe vararg methods

Constructor Detail

LintCategory	back to summary
private LintCategory(String option, Lint.LintCategory.Property... properties)

LintCategory	back to summary
private LintCategory(List<String> options, Lint.LintCategory.Property... properties)

Method Detail

createLookup	back to summary
private static SequencedMap<String, Lint.LintCategory> createLookup()

get back to summary

public static Optional<Lint.LintCategory> get(String option)

Get the LintCategory having the given command line option.

Parameters

option:String: lint category option string

Returns:Optional<Lint.LintCategory>

corresponding LintCategory, or empty if none exists

newEmptySet	back to summary
public static EnumSet<Lint.LintCategory> newEmptySet()

options	back to summary
public static SequencedSet<String> options() Get all lint category option strings and aliases.

valueOf	back to summary
public static Lint.LintCategory valueOf(String name)

values	back to summary
public static Lint.LintCategory[] values()

com.sun.tools.javac.code back to summary

pack-priv final Enum Lint.LintCategory.Property

Class Inheritance

extends Enum<Lint.LintCategory.Property>

java.lang.Object
java.lang.Enum
com.sun.tools.javac.code.Lint.LintCategory.Property

Field Summary

Modifier and Type	Field and Description
public static final Lint.LintCategory.Property	ENABLED_BY_DEFAULT
public static final Lint.LintCategory.Property	NO_ANNOTATION_SUPPRESSION

Constructor Summary

Access	Constructor and Description
private	Property()

Method Summary

Modifier and Type	Method and Description
public static Lint.LintCategory.Property	valueOf(String name)
public static Lint.LintCategory.Property[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ENABLED_BY_DEFAULT	back to summary
public static final Lint.LintCategory.Property ENABLED_BY_DEFAULT

NO_ANNOTATION_SUPPRESSION	back to summary
public static final Lint.LintCategory.Property NO_ANNOTATION_SUPPRESSION

Constructor Detail

Property	back to summary
private Property()

Method Detail

valueOf	back to summary
public static Lint.LintCategory.Property valueOf(String name)

values	back to summary
public static Lint.LintCategory.Property[] values()

public Class Lint

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Lint.LintCategory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum Lint.LintCategory.Property

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail