org.sonar.java.model

Class VisitorsBridgeForTests.TestJavaFileScannerContext

java.lang.Object

org.sonar.java.model.DefaultJavaFileScannerContext

org.sonar.java.model.VisitorsBridgeForTests.TestJavaFileScannerContext

All Implemented Interfaces:

JavaFileScannerContext

Enclosing class:

VisitorsBridgeForTests

public static class VisitorsBridgeForTests.TestJavaFileScannerContext
extends DefaultJavaFileScannerContext

Nested Class Summary

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

JavaFileScannerContext.Location

Constructor Summary

Constructors

Constructor and Description
TestJavaFileScannerContext(CompilationUnitTree tree, File file, SemanticModel semanticModel, SonarComponents sonarComponents, JavaVersion javaVersion, boolean failedParsing)

Method Summary

Modifier and Type	Method and Description
void	addIssue(int line, JavaCheck javaCheck, String message, Integer cost) Report an issue on a specific line.
Set<AnalyzerMessage>	getIssues()
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 org.sonar.java.model.DefaultJavaFileScannerContext

addIssue, addIssue, addIssueOnFile, createAnalyzerMessage, fileParsed, getComplexityNodes, getFile, getFileContent, getFileKey, getFileLines, getJavaVersion, getMethodComplexityNodes, getSemanticModel, getTree, reportIssue

Methods inherited from class java.lang.Object

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

Constructor Detail

TestJavaFileScannerContext

public TestJavaFileScannerContext(CompilationUnitTree tree,
                                  File file,
                                  SemanticModel semanticModel,
                                  @Nullable
                                  SonarComponents sonarComponents,
                                  JavaVersion javaVersion,
                                  boolean failedParsing)

Method Detail

getIssues

public Set<AnalyzerMessage> getIssues()

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.

Specified by:

addIssue in interface JavaFileScannerContext

Overrides:

addIssue in class DefaultJavaFileScannerContext

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.

See Also:

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

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

Overrides:

reportIssue in class DefaultJavaFileScannerContext

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.

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

Overrides:

reportIssue in class DefaultJavaFileScannerContext

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

Overrides:

reportIssue in class DefaultJavaFileScannerContext

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.

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

Overrides:

reportIssueWithFlow in class DefaultJavaFileScannerContext

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.