Class JavaFileScannerContextForTests

java.lang.Object

org.sonar.java.model.DefaultModuleScannerContext

org.sonar.java.model.DefaultInputFileScannerContext

org.sonar.java.model.DefaultJavaFileScannerContext

org.sonar.java.testing.JavaFileScannerContextForTests

All Implemented Interfaces:

MetricsScannerContext, RegexScannerContext, FluentReporting, InputFileScannerContext, JavaFileScannerContext, ModuleScannerContext

public class JavaFileScannerContextForTests
extends DefaultJavaFileScannerContext

Nested Class Summary

Nested classes/interfaces inherited from interface FluentReporting

FluentReporting.JavaIssueBuilder

Modifier and Type	Interface	Description
static interface	FluentReporting.JavaIssueBuilder

Nested classes/interfaces inherited from interface JavaFileScannerContext

JavaFileScannerContext.Location

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

Field Summary

Fields inherited from class DefaultInputFileScannerContext

inputFile

Modifier and Type	Field	Description
protected final org.sonar.api.batch.fs.InputFile	inputFile

Fields inherited from class DefaultModuleScannerContext

cacheContext, inAndroidContext, javaVersion, sonarComponents

Modifier and Type	Field	Description
protected final CacheContext	cacheContext
protected final boolean	inAndroidContext
protected final JavaVersion	javaVersion
protected final SonarComponents	sonarComponents

Constructor Summary

Constructors

Constructor	Description
JavaFileScannerContextForTests(CompilationUnitTree tree, org.sonar.api.batch.fs.InputFile inputFile, Sema semanticModel, SonarComponents sonarComponents, JavaVersion javaVersion, boolean failedParsing, boolean inAndroidContext, CacheContext cacheContext)

Method Summary

Modifier and Type	Method	Description
void	addIssue(int line, JavaCheck javaCheck, String message, Integer cost)	Report an issue on a specific line.
void	addIssueOnProject(JavaCheck javaCheck, String message)	Report an issue at the project level.
AnalyzerMessage	createAnalyzerMessage(JavaCheck javaCheck, Tree startTree, String message)
Set<AnalyzerMessage>	getIssues()
Map<AnalyzerMessage.TextSpan, List<JavaQuickFix>>	getQuickFixes()
FluentReporting.JavaIssueBuilder	newIssue()
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 DefaultJavaFileScannerContext

createAnalyzerMessage, fileParsed, getComplexityNodes, getFileContent, getFileLines, getMetricsComputer, getSemanticModel, getTree, regexForLiterals, reportIssue, reportIssue, sourceMap, throwIfEndOfAnalysisCheck

Modifier and Type	Method	Description
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)
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.
MetricsComputer	getMetricsComputer()
Sema	getSemanticModel()	Get semantic analysis.
CompilationUnitTree	getTree()	Parsed tree of the current file.
org.sonarsource.analyzer.commons.regex.RegexParseResult	regexForLiterals(org.sonarsource.analyzer.commons.regex.ast.FlagSet initialFlags, LiteralTree... stringLiterals)
void	reportIssue(RegexCheck regexCheck, Tree javaSyntaxElement, String message, Integer cost, List<RegexCheck.RegexIssueLocation> secondaries)
void	reportIssue(RegexCheck regexCheck, org.sonarsource.analyzer.commons.regex.ast.RegexSyntaxElement regexTree, String message, Integer cost, List<RegexCheck.RegexIssueLocation> secondaries)
Optional<SourceMap>	sourceMap()	Return JSR 45 source map for current input file
protected static void	throwIfEndOfAnalysisCheck(JavaCheck javaCheck)

Methods inherited from class DefaultInputFileScannerContext

addIssue, addIssueOnFile, getInputFile

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

Methods inherited from class DefaultModuleScannerContext

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

Modifier and Type	Method	Description
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()	The working directory used by the analysis.
boolean	inAndroidContext()	To be used to know if the current file is in an android context or not.
org.sonar.api.SonarProduct	sonarProduct()

Methods inherited from class Object

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

Constructor Details

JavaFileScannerContextForTests

public JavaFileScannerContextForTests(CompilationUnitTree tree,
 org.sonar.api.batch.fs.InputFile inputFile,
 Sema semanticModel,
 @Nullable
 SonarComponents sonarComponents,
 JavaVersion javaVersion,
 boolean failedParsing,
 boolean inAndroidContext,
 @Nullable
 CacheContext cacheContext)

Method Details

getIssues

public Set<AnalyzerMessage> getIssues()

getQuickFixes

public Map<AnalyzerMessage.TextSpan, List<JavaQuickFix>> getQuickFixes()

addIssueOnProject

public void addIssueOnProject(JavaCheck javaCheck,
 String message)

Description copied from interface: ModuleScannerContext

Report an issue at the project level.

Specified by:

addIssueOnProject in interface ModuleScannerContext

Overrides:

addIssueOnProject in class DefaultModuleScannerContext

Parameters:

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: InputFileScannerContext

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

Specified by:

addIssue in interface InputFileScannerContext

Overrides:

addIssue in class DefaultInputFileScannerContext

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.

reportIssue

public void reportIssue(JavaCheck javaCheck,
 Tree tree,
 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

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

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.

reportIssue

public void reportIssue(AnalyzerMessage message)

Overrides:

reportIssue in class DefaultModuleScannerContext

createAnalyzerMessage

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

Overrides:

createAnalyzerMessage in class DefaultJavaFileScannerContext

newIssue

public FluentReporting.JavaIssueBuilder newIssue()

Specified by:

newIssue in interface FluentReporting

Overrides:

newIssue in class DefaultJavaFileScannerContext