Package org.sonar.java.model

Class DefaultInputFileScannerContext

java.lang.Object

org.sonar.java.model.DefaultModuleScannerContext

org.sonar.java.model.DefaultInputFileScannerContext

All Implemented Interfaces:

InputFileScannerContext, ModuleScannerContext

Direct Known Subclasses:

DefaultJavaFileScannerContext

public class DefaultInputFileScannerContext
extends DefaultModuleScannerContext
implements InputFileScannerContext

Field Summary

Fields

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

Fields inherited from class org.sonar.java.model.DefaultModuleScannerContext

cacheContext, inAndroidContext, javaVersion, sonarComponents

Constructor Summary

Constructors

Constructor	Description
DefaultInputFileScannerContext(SonarComponents sonarComponents, org.sonar.api.batch.fs.InputFile inputFile, JavaVersion javaVersion, boolean inAndroidContext, CacheContext cacheContext)

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	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 org.sonar.java.model.DefaultModuleScannerContext

addIssueOnProject, getCacheContext, getJavaVersion, getModuleKey, getProject, getRootProjectWorkingDirectory, getWorkingDirectory, inAndroidContext, reportIssue, sonarProduct

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonar.plugins.java.api.ModuleScannerContext

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

Field Details

inputFile

protected final org.sonar.api.batch.fs.InputFile inputFile

Constructor Details

DefaultInputFileScannerContext

public DefaultInputFileScannerContext(@Nullable
 SonarComponents sonarComponents,
 org.sonar.api.batch.fs.InputFile inputFile,
 JavaVersion javaVersion,
 boolean inAndroidContext,
 @Nullable
 CacheContext cacheContext)

Method Details

addIssueOnFile

public void addIssueOnFile(JavaCheck javaCheck,
 String message)

Description copied from interface: InputFileScannerContext

Report an issue at file level.

Specified by:

addIssueOnFile in interface InputFileScannerContext

Parameters:

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

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

Specified by:

addIssue in interface InputFileScannerContext

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

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.

getInputFile

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

Description copied from interface: InputFileScannerContext

InputFile under analysis.

Specified by:

getInputFile in interface InputFileScannerContext

Returns:

the currently analyzed InputFile.