Package org.sonar.plugins.java.api

Interface InputFileScannerContext

All Superinterfaces:

ModuleScannerContext

All Known Subinterfaces:

JavaFileScannerContext

All Known Implementing Classes:

DefaultInputFileScannerContext, DefaultJavaFileScannerContext, JavaFileScannerContextForTests

public interface InputFileScannerContext
extends ModuleScannerContext

Method Summary

Modifier and Type	Method	Description
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.
org.sonar.api.batch.fs.InputFile	getInputFile()	InputFile under analysis.

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

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

Method Details

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. Prefer JavaFileScannerContext.reportIssue(JavaCheck, Tree, String) for more precise reporting.

Parameters:

line - line on which to report the issue

check - The check raising the issue.

message - Message to display to the user

addIssue

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

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

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.

getInputFile

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

InputFile under analysis.

Returns:

the currently analyzed InputFile.

Since:

SonarJava 5.12: Dropping support of file-related methods