org.sonar.plugins.java.api

Interface JavaFileScannerContext

All Known Implementing Classes:

DefaultJavaFileScannerContext, VisitorsBridgeForTests.TestJavaFileScannerContext

@Beta
public interface JavaFileScannerContext

Context injected in check classes and used to report issues.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addIssue(File file, JavaCheck check, int line, String message) Report an issue at a specific line of a given file.
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.
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.
File	getFile() File under analysis.
String	getFileContent() Content of the currently analyzed file.
String	getFileKey() FileKey of currently analyzed file.
List<String>	getFileLines() Lines of the currently analyzed file.
JavaVersion	getJavaVersion() Java version defined for the analysis using sonar.java.version parameter.
List<Tree>	getMethodComplexityNodes(ClassTree enclosingClass, MethodTree methodTree) Deprecated. use getComplexityNodes(Tree) instead
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.

Method Detail

getTree

CompilationUnitTree getTree()

Parsed tree of the current file.

Returns:

CompilationUnitTree ready for scan by checks.

addIssueOnFile

void addIssueOnFile(JavaCheck check,
                    String message)

Report an issue at file level.

Parameters:

check - The check raising the issue.

message - Message to display to the user

addIssue

void addIssue(int line,
              JavaCheck check,
              String message)

Report an issue on a specific line.

Parameters:

line - line on which to report the issue

check - The check raising the issue.

message - Message to display to the user

See Also:

JavaFileScannerContext#reportIssue(JavaCheck, Tree, String)} which should be prefered as reporting will be more precise.

addIssue

void addIssue(int line,
              JavaCheck check,
              String message,
              @Nullable
              Integer cost)

Report an issue on a specific line.

Parameters:

line - line on which to report the issue

check - The check raising the issue.

message - Message to display to the user

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

See Also:

JavaFileScannerContext#reportIssue(JavaCheck, Tree, String, List, Integer)} which should be prefered as reporting will be more precise.

addIssue

void addIssue(File file,
              JavaCheck check,
              int line,
              String message)

Report an issue at a specific line of a given file. This method is used for one

Parameters:

file - File on which to report

check - The check raising the issue.

line - line on which to report the issue

message - Message to display to the user

getSemanticModel

@Nullable
Object getSemanticModel()

Get semantic analysis.

Returns:

SemanticModel if semantic analysis was successful, null otherwise.

getFileKey

String getFileKey()

FileKey of currently analyzed file.

Returns:

the fileKey of the file currently analyzed.

getFile

File getFile()

File under analysis.

Returns:

the currently analysed file.

getJavaVersion

JavaVersion getJavaVersion()

Java version defined for the analysis using sonar.java.version parameter.

Returns:

JavaVersion object with API to act on it.

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.

getMethodComplexityNodes

@Deprecated
List<Tree> getMethodComplexityNodes(ClassTree enclosingClass,
                                                MethodTree methodTree)

Deprecated. use getComplexityNodes(Tree) instead

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

Parameters:

enclosingClass - not used.

methodTree - the methodTree 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.