Package org.sonar.java.model

Class DefaultJavaFileScannerContext

java.lang.Object

org.sonar.java.model.DefaultJavaFileScannerContext

All Implemented Interfaces:

JavaFileScannerContext

Direct Known Subclasses:

VisitorsBridgeForTests.TestJavaFileScannerContext

public class DefaultJavaFileScannerContext
extends Object
implements JavaFileScannerContext

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.plugins.java.api.JavaFileScannerContext

JavaFileScannerContext.Location

Constructor Summary

Constructors

Constructor	Description
DefaultJavaFileScannerContext(CompilationUnitTree tree, org.sonar.api.batch.fs.InputFile inputFile, SemanticModel semanticModel, SonarComponents sonarComponents, JavaVersion javaVersion, boolean fileParsed)

Method Summary

Modifier and Type	Method	Description
void	addIssue(int line, JavaCheck javaCheck, String message)	Report an issue on a specific line.
void	addIssue(int line, JavaCheck javaCheck, String message, Integer cost)	Report an issue on a specific line.
void	addIssue(File file, JavaCheck check, int line, String message)	Deprecated. since SonarJava 5.12 - Use 'reportIssue' instead, or dedicated method to report issue directly on file or project
void	addIssueOnFile(JavaCheck javaCheck, String message)	Report an issue at file level.
void	addIssueOnProject(JavaCheck check, String message)	Report an issue at at the project level.
protected static AnalyzerMessage	createAnalyzerMessage(org.sonar.api.batch.fs.InputFile inputFile, JavaCheck javaCheck, Tree startTree, Tree endTree, String message, Iterable<List<JavaFileScannerContext.Location>> flows, Integer cost)
AnalyzerMessage	createAnalyzerMessage(JavaCheck javaCheck, Tree startTree, String message)
boolean	fileParsed()	Checks if file has been parsed correctly.
File	getBaseDirectory()
List<Tree>	getComplexityNodes(Tree tree)	Computes the list of syntax nodes which are contributing to increase the complexity for the given methodTree.
File	getFile()	Deprecated. since SonarJava 5.12 - Rely on getInputFile() instead
String	getFileContent()	Content of the currently analyzed file.
String	getFileKey()	Deprecated. since SonarJava 5.12 - Use key of InputFile instead, using getInputFile().
List<String>	getFileLines()	Lines of the currently analyzed file.
org.sonar.api.batch.fs.InputFile	getInputFile()	InputFile under analysis.
JavaVersion	getJavaVersion()	Java version defined for the analysis using sonar.java.version parameter.
org.sonar.api.batch.fs.InputComponent	getProject()	InputComponent representing the project being analyzed
Object	getSemanticModel()	Get semantic analysis.
CompilationUnitTree	getTree()	Parsed tree of the current file.
File	getWorkingDirectory()	The working directory used by the analysis.
void	reportIssue(AnalyzerMessage message)
void	reportIssue(JavaCheck javaCheck, Tree tree, String message)	Report an issue.
void	reportIssue(JavaCheck javaCheck, Tree syntaxNode, String message, List<JavaFileScannerContext.Location> secondary, 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> secondary, Integer cost)	Report an issue.
void	reportIssueWithFlow(JavaCheck javaCheck, Tree syntaxNode, String message, Iterable<List<JavaFileScannerContext.Location>> flows, Integer cost)	Report an issue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultJavaFileScannerContext

public DefaultJavaFileScannerContext(CompilationUnitTree tree,
                                     org.sonar.api.batch.fs.InputFile inputFile,
                                     SemanticModel semanticModel,
                                     @Nullable
                                     SonarComponents sonarComponents,
                                     JavaVersion javaVersion,
                                     boolean fileParsed)

Method Detail

getTree

public CompilationUnitTree getTree()

Description copied from interface: JavaFileScannerContext

Parsed tree of the current file.

Specified by:

getTree in interface JavaFileScannerContext

Returns:

CompilationUnitTree ready for scan by checks.

addIssueOnFile

public void addIssueOnFile(JavaCheck javaCheck,
                           String message)

Description copied from interface: JavaFileScannerContext

Report an issue at file level.

Specified by:

addIssueOnFile in interface JavaFileScannerContext

Parameters:

javaCheck - The check raising the issue.

message - Message to display to the user

addIssueOnProject

public void addIssueOnProject(JavaCheck check,
                              String message)

Description copied from interface: JavaFileScannerContext

Report an issue at at the project level.

Specified by:

addIssueOnProject in interface JavaFileScannerContext

Parameters:

check - The check raising the issue.

message - Message to display to the user

addIssue

public void addIssue(int line,
                     JavaCheck javaCheck,
                     String message)

Description copied from interface: JavaFileScannerContext

Report an issue on a specific line. Prefer JavaFileScannerContext.reportIssue(JavaCheck, Tree, String) for more precise reporting.

Specified by:

addIssue in interface JavaFileScannerContext

Parameters:

line - line on which to report the issue

javaCheck - The check raising the issue.

message - Message to display to the user

addIssue

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

Description copied from interface: JavaFileScannerContext

Report an issue on a specific line. Prefer JavaFileScannerContext.reportIssue(JavaCheck, Tree, String, List, Integer) for more precise reporting.

Specified by:

addIssue in interface JavaFileScannerContext

Parameters:

line - line on which to report the issue

javaCheck - The check raising the issue.

message - Message to display to the user

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

getSemanticModel

@Nullable
public Object getSemanticModel()

Description copied from interface: JavaFileScannerContext

Get semantic analysis.

Specified by:

getSemanticModel in interface JavaFileScannerContext

Returns:

SemanticModel if semantic analysis was successful, null otherwise.

getJavaVersion

public JavaVersion getJavaVersion()

Description copied from interface: JavaFileScannerContext

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

Specified by:

getJavaVersion in interface JavaFileScannerContext

Returns:

JavaVersion object with API to act on it.

fileParsed

public boolean fileParsed()

Description copied from interface: JavaFileScannerContext

Checks if file has been parsed correctly.

Specified by:

fileParsed in interface JavaFileScannerContext

Returns:

true if parsing was successful

getFileKey

@Deprecated
public String getFileKey()

Deprecated.

since SonarJava 5.12 - Use key of InputFile instead, using getInputFile().

Description copied from interface: JavaFileScannerContext

FileKey of currently analyzed file.

Specified by:

getFileKey in interface JavaFileScannerContext

Returns:

the fileKey of the file currently analyzed.

addIssue

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

Deprecated.

since SonarJava 5.12 - Use 'reportIssue' instead, or dedicated method to report issue directly on file or project

Description copied from interface: JavaFileScannerContext

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

Specified by:

addIssue in interface JavaFileScannerContext

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

reportIssue

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

Description copied from interface: JavaFileScannerContext

Report an issue.

Specified by:

reportIssue in interface JavaFileScannerContext

Parameters:

javaCheck - check raising the issue

tree - syntax node on which to raise the issue.

message - Message to display to the user.

reportIssue

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

Description copied from interface: JavaFileScannerContext

Report an issue.

Specified by:

reportIssue in interface JavaFileScannerContext

Parameters:

javaCheck - check raising the issue

syntaxNode - syntax node on which to raise the issue.

message - Message to display to the user.

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

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

reportIssueWithFlow

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

Description copied from interface: JavaFileScannerContext

Report an issue.

Specified by:

reportIssueWithFlow in interface JavaFileScannerContext

Parameters:

javaCheck - check raising the issue

syntaxNode - 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

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

Description copied from interface: JavaFileScannerContext

Report an issue.

Specified by:

reportIssue in interface JavaFileScannerContext

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

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

Description copied from interface: JavaFileScannerContext

Report an issue.

Specified by:

reportIssue in interface JavaFileScannerContext

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.

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

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

getFileLines

public List<String> getFileLines()

Description copied from interface: JavaFileScannerContext

Lines of the currently analyzed file.

Specified by:

getFileLines in interface JavaFileScannerContext

Returns:

list of file lines.

getFileContent

public String getFileContent()

Description copied from interface: JavaFileScannerContext

Content of the currently analyzed file.

Specified by:

getFileContent in interface JavaFileScannerContext

Returns:

the file content as a String.

reportIssue

public void reportIssue(AnalyzerMessage message)

createAnalyzerMessage

public AnalyzerMessage createAnalyzerMessage(JavaCheck javaCheck,
                                             Tree startTree,
                                             String message)

createAnalyzerMessage

protected static AnalyzerMessage createAnalyzerMessage(org.sonar.api.batch.fs.InputFile inputFile,
                                                       JavaCheck javaCheck,
                                                       Tree startTree,
                                                       @Nullable
                                                       Tree endTree,
                                                       String message,
                                                       Iterable<List<JavaFileScannerContext.Location>> flows,
                                                       @Nullable
                                                       Integer cost)

getFile

@Deprecated
public File getFile()

Deprecated.

since SonarJava 5.12 - Rely on getInputFile() instead

Description copied from interface: JavaFileScannerContext

File under analysis.

Specified by:

getFile in interface JavaFileScannerContext

Returns:

the currently analyzed file.

getInputFile

public org.sonar.api.batch.fs.InputFile getInputFile()

Description copied from interface: JavaFileScannerContext

InputFile under analysis.

Specified by:

getInputFile in interface JavaFileScannerContext

Returns:

the currently analyzed InputFile.

getProject

public org.sonar.api.batch.fs.InputComponent getProject()

Description copied from interface: JavaFileScannerContext

InputComponent representing the project being analyzed

Specified by:

getProject in interface JavaFileScannerContext

Returns:

the project component

getWorkingDirectory

public File getWorkingDirectory()

Description copied from interface: JavaFileScannerContext

The working directory used by the analysis.

Specified by:

getWorkingDirectory in interface JavaFileScannerContext

Returns:

the current working directory.

getBaseDirectory

public File getBaseDirectory()

getComplexityNodes

public List<Tree> getComplexityNodes(Tree tree)

Description copied from interface: JavaFileScannerContext

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

Specified by:

getComplexityNodes in interface JavaFileScannerContext

Parameters:

tree - the tree to compute the complexity.

Returns:

the list of syntax nodes incrementing the complexity.