Maps source code positions to the applicable Lint instance.

Because @SuppressWarnings is a Java symbol, in general this mapping can't be calculated until after attribution. As each top-level declaration (class, package, or module) is attributed, this singleton is notified and the Lints that apply to every source position within that top-level declaration are calculated.

The method lintAt returns the Lint instance applicable to source position; if it can't be determined yet, an empty Optional is returned.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	LintMapper.FileInfo Holds `Lint` information for a fully parsed source file.
private static record	LintMapper.LintRange A tree of nested lexical ranges and the `Lint` configurations that apply therein.
private static record	LintMapper.Span A lexical range.

Field Summary

Modifier and Type	Field and Description
private final Context	context
private static final Context.Key<LintMapper>	CONTEXT_KEY
private final Map<JavaFileObject, LintMapper.FileInfo>	fileInfoMap
private Lint	rootLint

Access	Constructor and Description
protected	LintMapper(Context context) Constructor.

Method Summary

Modifier and Type	Method and Description
public void	calculateLints(JavaFileObject source file sourceFile, JCTree top-level declaration (class, package, or module) tree) Calculate {@lint Lint} configurations for all positions within the given top-level declaration.
public void	clear() Reset this instance.
public void	finishParsingFile(JCTree.JCCompilationUnit tree) Invoked when file parsing completes to put in place a corresponding `FileInfo`.
private void	initializeIfNeeded()
public static LintMapper	instance(Context context) Obtain the `LintMapper` context singleton.
public boolean	Returns: true if file is recognized isKnown(JavaFileObject source file sourceFile) Determine if the given file is known to this instance.
public Optional<Lint>	Returns: the applicable `Lint`, if known, otherwise empty lintAt(JavaFileObject source file sourceFile, JCDiagnostic.DiagnosticPosition source position pos) Obtain the `Lint` configuration that applies at the given position, if known.
public void	startParsingFile(JavaFileObject sourceFile) Invoked when file parsing starts to create an entry for the new file (but with a null value).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

context	back to summary
private final Context context

CONTEXT_KEY	back to summary
private static final Context.Key<LintMapper> CONTEXT_KEY

fileInfoMap	back to summary
private final Map<JavaFileObject, LintMapper.FileInfo> fileInfoMap

rootLint	back to summary
private Lint rootLint

LintMapper	back to summary
protected LintMapper(Context context) Constructor. Annotations @SuppressWarnings:this-escape

Method Detail

calculateLints	back to summary
public void calculateLints(JavaFileObject sourceFile, JCTree tree) Calculate {@lint Lint} configurations for all positions within the given top-level declaration. Parameters sourceFile:JavaFileObject source file tree:JCTree top-level declaration (class, package, or module)

calculateLints

back to summary

public void calculateLints(JavaFileObject sourceFile, JCTree tree)

Calculate {@lint Lint} configurations for all positions within the given top-level declaration.

Parameters

sourceFile:JavaFileObject: source file
tree:JCTree: top-level declaration (class, package, or module)

clear	back to summary
public void clear() Reset this instance.

finishParsingFile	back to summary
public void finishParsingFile(JCTree.JCCompilationUnit tree) Invoked when file parsing completes to put in place a corresponding `FileInfo`.

initializeIfNeeded	back to summary
private void initializeIfNeeded()

instance	back to summary
public static LintMapper instance(Context context) Obtain the `LintMapper` context singleton.

isKnown	back to summary
public boolean isKnown(JavaFileObject sourceFile) Determine if the given file is known to this instance. Parameters sourceFile:JavaFileObject source file Returns:boolean true if file is recognized

isKnown

back to summary

public boolean isKnown(JavaFileObject sourceFile)

Determine if the given file is known to this instance.

Parameters

sourceFile:JavaFileObject: source file

Returns:boolean

true if file is recognized

lintAt back to summary

lintAt	back to summary
public Optional<Lint> lintAt(JavaFileObject sourceFile, JCDiagnostic.DiagnosticPosition pos) Obtain the `Lint` configuration that applies at the given position, if known. Parameters sourceFile:JavaFileObject source file pos:JCDiagnostic.DiagnosticPosition source position Returns:Optional<Lint> the applicable `Lint`, if known, otherwise empty

public Optional<Lint> lintAt(JavaFileObject sourceFile, JCDiagnostic.DiagnosticPosition pos)

Obtain the Lint configuration that applies at the given position, if known.

Parameters

sourceFile:JavaFileObject: source file
pos:JCDiagnostic.DiagnosticPosition: source position

Returns:Optional<Lint>

the applicable Lint, if known, otherwise empty

startParsingFile	back to summary
public void startParsingFile(JavaFileObject sourceFile) Invoked when file parsing starts to create an entry for the new file (but with a null value).

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

private Class LintMapper.FileInfo

Class Inheritance

extends Object

java.lang.Object
com.sun.tools.javac.code.LintMapper.FileInfo

Holds Lint information for a fully parsed source file.

Initially (immediately after parsing), "unmappedDecls" contains a Span corresponding to each top-level declaration in the source file. As each top-level declaration is attributed, the corresponding Span is removed and the corresponding LintRange subtree is populated under "rootRange".

Field Summary

Modifier and Type	Field and Description
pack-priv final LintMapper.LintRange	rootRange
pack-priv final List<LintMapper.Span>	unmappedDecls

Constructor Summary

Access	Constructor and Description
pack-priv	FileInfo(Lint rootLint, JCTree.JCCompilationUnit tree)

Method Summary

Modifier and Type	Method and Description
pack-priv void	afterAttr(JCTree tree)
pack-priv boolean	isTopLevelDecl(JCTree tree)
pack-priv Optional<Lint>	lintAt(JCDiagnostic.DiagnosticPosition pos)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

rootRange	back to summary
pack-priv final LintMapper.LintRange rootRange

unmappedDecls	back to summary
pack-priv final List<LintMapper.Span> unmappedDecls

Constructor Detail

FileInfo	back to summary
pack-priv FileInfo(Lint rootLint, JCTree.JCCompilationUnit tree)

Method Detail

afterAttr	back to summary
pack-priv void afterAttr(JCTree tree)

isTopLevelDecl	back to summary
pack-priv boolean isTopLevelDecl(JCTree tree)

lintAt	back to summary
pack-priv Optional<Lint> lintAt(JCDiagnostic.DiagnosticPosition pos)

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

private final Record LintMapper.LintRange

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
com.sun.tools.javac.code.LintMapper.LintRange

Record Components

span:LintMapper.Span
lint:Lint
children:List<LintMapper.LintRange>

A tree of nested lexical ranges and the Lint configurations that apply therein.

Field Summary

Modifier and Type	Field and Description
private final List<LintMapper.LintRange>	children Record Component accessed by children().
private final Lint	lint Record Component accessed by lint().
private final LintMapper.Span	span Record Component accessed by span().

Constructor Summary

Access	Constructor and Description
pack-priv	LintRange(Lint rootLint)
pack-priv	LintRange(JCTree tree, Lint lint)
private	LintRange(LintMapper.Span span, Lint lint, List<LintMapper.LintRange> children)

Method Summary

Modifier and Type	Method and Description
pack-priv LintMapper.LintRange	bestMatch(JCDiagnostic.DiagnosticPosition pos)
public List<LintMapper.LintRange>	children() Record Component getter of children.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public Lint	lint() Record Component getter of lint.
pack-priv void	populateSubtree(JCTree tree)
public LintMapper.Span	span() Record Component getter of span.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

children	back to summary
private final List<LintMapper.LintRange> children Record Component accessed by children().

lint	back to summary
private final Lint lint Record Component accessed by lint().

span	back to summary
private final LintMapper.Span span Record Component accessed by span().

Constructor Detail

LintRange	back to summary
pack-priv LintRange(Lint rootLint)

LintRange	back to summary
pack-priv LintRange(JCTree tree, Lint lint)

LintRange	back to summary
private LintRange(LintMapper.Span span, Lint lint, List<LintMapper.LintRange> children)

Method Detail

bestMatch	back to summary
pack-priv LintMapper.LintRange bestMatch(JCDiagnostic.DiagnosticPosition pos)

children	back to summary
public List<LintMapper.LintRange> children() Record Component getter of children.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

lint	back to summary
public Lint lint() Record Component getter of lint.

populateSubtree	back to summary
pack-priv void populateSubtree(JCTree tree)

span	back to summary
public LintMapper.Span span() Record Component getter of span.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

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

private final Record LintMapper.Span

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
com.sun.tools.javac.code.LintMapper.Span

Record Components

startPos:int
endPos:int

A lexical range.

Field Summary

Modifier and Type	Field and Description
private final int	endPos Record Component accessed by endPos().
pack-priv static final LintMapper.Span	MAXIMAL
private final int	startPos Record Component accessed by startPos().

Constructor Summary

Access	Constructor and Description
pack-priv	Span(JCTree tree)
private	Span(int startPos, int endPos)

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	contains(JCDiagnostic.DiagnosticPosition pos)
pack-priv boolean	contains(LintMapper.Span that)
public int	endPos() Record Component getter of endPos.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public int	startPos() Record Component getter of startPos.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

endPos	back to summary
private final int endPos Record Component accessed by endPos().

MAXIMAL	back to summary
pack-priv static final LintMapper.Span MAXIMAL

startPos	back to summary
private final int startPos Record Component accessed by startPos().

Constructor Detail

Span	back to summary
pack-priv Span(JCTree tree)

Span	back to summary
private Span(int startPos, int endPos)

Method Detail

contains	back to summary
pack-priv boolean contains(JCDiagnostic.DiagnosticPosition pos)

contains	back to summary
pack-priv boolean contains(LintMapper.Span that)

endPos	back to summary
public int endPos() Record Component getter of endPos.

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

startPos	back to summary
public int startPos() Record Component getter of startPos.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

public Class LintMapper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class LintMapper.FileInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record LintMapper.LintRange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record LintMapper.Span

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail