Interface JavaFileScannerContext

All Superinterfaces:

InputFileScannerContext, ModuleScannerContext

All Known Implementing Classes:

DefaultJavaFileScannerContext, JavaFileScannerContextForTests

@Beta
public interface JavaFileScannerContext
extends InputFileScannerContext

Context injected in check classes and used to report issues.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JavaFileScannerContext.Location	Message and syntaxNode for a secondary location.

Method Summary

Modifier and Type	Method	Description
boolean	fileParsed()	Checks if file has been parsed correctly.
List<Tree>	getComplexityNodes(Tree tree)	Computes the list of syntax nodes which are contributing to increase the complexity for the given methodTree.
String	getFileContent()	Content of the currently analyzed file.
List<String>	getFileLines()	Lines of the currently analyzed file.
Object	getSemanticModel()	Get semantic analysis.
CompilationUnitTree	getTree()	Parsed tree of the current file.
void	reportIssue(JavaCheck javaCheck, Tree tree, String message)	Report an issue.
void	reportIssue(JavaCheck javaCheck, Tree tree, String message, List<JavaFileScannerContext.Location> secondaryLocations, Integer cost)	Report an issue.
void	reportIssue(JavaCheck javaCheck, Tree startTree, Tree endTree, String message)	Report an issue.
void	reportIssue(JavaCheck javaCheck, Tree startTree, Tree endTree, String message, List<JavaFileScannerContext.Location> secondaryLocations, Integer cost)	Report an issue.
void	reportIssueWithFlow(JavaCheck javaCheck, Tree tree, String message, Iterable<List<JavaFileScannerContext.Location>> flows, Integer cost)	Report an issue.
default Optional<SourceMap>	sourceMap()	Return JSR 45 source map for current input file

Methods inherited from interface InputFileScannerContext

addIssue, addIssue, addIssueOnFile, getInputFile

Modifier and Type	Method	Description
void	addIssue(int line, JavaCheck check, String message)	Report an issue on a specific line.
void	addIssue(int line, JavaCheck check, String message, Integer cost)	Report an issue on a specific line.
void	addIssueOnFile(JavaCheck check, String message)	Report an issue at file level.
org.sonar.api.batch.fs.InputFile	getInputFile()	InputFile under analysis.

Methods inherited from interface ModuleScannerContext

addIssueOnProject, getCacheContext, getConfiguration, getFullyQualifiedModuleKey, getJavaVersion, getModuleKey, getProject, getRootProjectWorkingDirectory, getWorkingDirectory, inAndroidContext, sonarProduct

Modifier and Type	Method	Description
void	addIssueOnProject(JavaCheck check, String message)	Report an issue at the project level.
CacheContext	getCacheContext()
org.sonar.api.config.Configuration	getConfiguration()
Optional<String>	getFullyQualifiedModuleKey()
JavaVersion	getJavaVersion()	Java version defined for the analysis using sonar.java.version parameter.
String	getModuleKey()
org.sonar.api.batch.fs.InputComponent	getProject()	InputComponent representing the project being analyzed
File	getRootProjectWorkingDirectory()
File	getWorkingDirectory()	Deprecated. use ModuleScannerContext.getRootProjectWorkingDirectory() instead
boolean	inAndroidContext()	To be used to know if the current file is in an android context or not.
org.sonar.api.SonarProduct	sonarProduct()

Method Details

getTree

CompilationUnitTree getTree()

Parsed tree of the current file.

Returns:

CompilationUnitTree ready for scan by checks.

getSemanticModel

@Nullable
Object getSemanticModel()

Get semantic analysis.

Returns:

SemanticModel if semantic analysis was successful, null otherwise.

fileParsed

boolean fileParsed()

Checks if file has been parsed correctly.

Returns:

true if parsing was successful

getComplexityNodes

List<Tree> getComplexityNodes(Tree tree)

Computes the list of syntax nodes which are contributing to increase the complexity for the given methodTree.

Parameters:

tree - the tree to compute the complexity.

Returns:

the list of syntax nodes incrementing the complexity.

reportIssue

void reportIssue(JavaCheck javaCheck,
 Tree tree,
 String message)

Report an issue.

Parameters:

javaCheck - check raising the issue

tree - syntax node on which to raise the issue.

message - Message to display to the user.

reportIssue

void reportIssue(JavaCheck javaCheck,
 Tree tree,
 String message,
 List<JavaFileScannerContext.Location> secondaryLocations,
 @Nullable
 Integer cost)

Report an issue.

Parameters:

javaCheck - check raising the issue

tree - syntax node on which to raise the issue.

message - Message to display to the user.

secondaryLocations - List of JavaFileScannerContext.Location to display secondary location for the issue.

cost - computed remediation cost if applicable, null if not.

reportIssueWithFlow

void reportIssueWithFlow(JavaCheck javaCheck,
 Tree tree,
 String message,
 Iterable<List<JavaFileScannerContext.Location>> flows,
 @Nullable
 Integer cost)

Report an issue.

Parameters:

javaCheck - check raising the issue

tree - syntax node on which to raise the issue.

message - Message to display to the user.

flows - List of list of JavaFileScannerContext.Location to display flows for the issue.

cost - computed remediation cost if applicable, null if not.

reportIssue

void reportIssue(JavaCheck javaCheck,
 Tree startTree,
 Tree endTree,
 String message)

Report an issue.

Parameters:

javaCheck - check raising the issue

startTree - syntax node on which to start the highlighting of the issue.

endTree - syntax node on which to end the highlighting of the issue.

message - Message to display to the user.

reportIssue

void reportIssue(JavaCheck javaCheck,
 Tree startTree,
 Tree endTree,
 String message,
 List<JavaFileScannerContext.Location> secondaryLocations,
 @Nullable
 Integer cost)

Report an issue.

Parameters:

javaCheck - check raising the issue

startTree - syntax node on which to start the highlighting of the issue.

endTree - syntax node on which to end the highlighting of the issue.

message - Message to display to the user.

secondaryLocations - List of JavaFileScannerContext.Location to display secondary location for the issue.

cost - computed remediation cost if applicable, null if not.

getFileLines

List<String> getFileLines()

Lines of the currently analyzed file.

Returns:

list of file lines.

getFileContent

String getFileContent()

Content of the currently analyzed file.

Returns:

the file content as a String.

sourceMap

default Optional<SourceMap> sourceMap()

Return JSR 45 source map for current input file

Returns:

source map if available