Package org.sonar.java

Class SonarComponents

java.lang.Object

org.sonar.java.SonarComponents

@ScannerSide
@SonarLintSide
public class SonarComponents
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
List<AnalysisError>	analysisErrors
static String	COLLECT_ANALYSIS_ERRORS_KEY
static String	FAIL_ON_EXCEPTION_KEY
static org.sonar.api.measures.Metric<String>	FEEDBACK_METRIC	Metric to collect

Constructor Summary

Constructors

Constructor	Description
SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory, org.sonar.api.batch.fs.FileSystem fs, JavaClasspath javaClasspath, JavaTestClasspath javaTestClasspath, org.sonar.api.batch.rule.CheckFactory checkFactory)
SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory, org.sonar.api.batch.fs.FileSystem fs, JavaClasspath javaClasspath, JavaTestClasspath javaTestClasspath, org.sonar.api.batch.rule.CheckFactory checkFactory, org.sonar.api.batch.bootstrap.ProjectDefinition projectDefinition)	Will be called in SonarScanner context when no custom rules is present
SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory, org.sonar.api.batch.fs.FileSystem fs, JavaClasspath javaClasspath, JavaTestClasspath javaTestClasspath, org.sonar.api.batch.rule.CheckFactory checkFactory, CheckRegistrar[] checkRegistrars)	Will be called in SonarLint context when custom rules are present
SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory, org.sonar.api.batch.fs.FileSystem fs, JavaClasspath javaClasspath, JavaTestClasspath javaTestClasspath, org.sonar.api.batch.rule.CheckFactory checkFactory, CheckRegistrar[] checkRegistrars, org.sonar.api.batch.bootstrap.ProjectDefinition projectDefinition)	ProjectDefinition class is not available in SonarLint context, so this constructor will never be called when using SonarLint

Method Summary

Modifier and Type	Method	Description
void	addAnalysisError(AnalysisError analysisError)
void	addIssue(org.sonar.api.batch.fs.InputComponent inputComponent, JavaCheck check, int line, String message, Integer cost)
boolean	analysisCancelled()
File	baseDir()
JavaCheck[]	checkClasses()
Iterable<org.sonar.api.batch.rule.Checks<JavaCheck>>	checks()
List<String>	fileLines(org.sonar.api.batch.fs.InputFile inputFile)
org.sonar.api.measures.FileLinesContext	fileLinesContextFor(org.sonar.api.batch.fs.InputFile inputFile)
List<File>	getJavaClasspath()
List<File>	getJavaTestClasspath()
org.sonar.api.rule.RuleKey	getRuleKey(JavaCheck check)
org.sonar.api.batch.sensor.highlighting.NewHighlighting	highlightableFor(org.sonar.api.batch.fs.InputFile inputFile)
String	inputFileContents(org.sonar.api.batch.fs.InputFile inputFile)
boolean	isSonarLintContext()
org.sonar.api.batch.fs.InputComponent	project()
void	registerCheckClasses(String repositoryKey, Iterable<Class<? extends JavaCheck>> checkClasses)
void	registerTestCheckClasses(String repositoryKey, Iterable<Class<? extends JavaCheck>> checkClasses)
boolean	reportAnalysisError(com.sonar.sslr.api.RecognitionException re, org.sonar.api.batch.fs.InputFile inputFile)
void	reportAnalysisError(org.sonar.api.batch.fs.InputFile inputFile, String message)
void	reportIssue(AnalyzerMessage analyzerMessage)
void	saveAnalysisErrors()
void	setSensorContext(org.sonar.api.batch.sensor.SensorContext context)
boolean	shouldFailAnalysisOnException()
org.sonar.api.batch.sensor.symbol.NewSymbolTable	symbolizableFor(org.sonar.api.batch.fs.InputFile inputFile)
Collection<JavaCheck>	testCheckClasses()
File	workDir()

Methods inherited from class java.lang.Object

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

Field Detail

FEEDBACK_METRIC

public static final org.sonar.api.measures.Metric<String> FEEDBACK_METRIC

Metric to collect

COLLECT_ANALYSIS_ERRORS_KEY

public static final String COLLECT_ANALYSIS_ERRORS_KEY

See Also:

Constant Field Values

FAIL_ON_EXCEPTION_KEY

public static final String FAIL_ON_EXCEPTION_KEY

See Also:

Constant Field Values

analysisErrors

public List<AnalysisError> analysisErrors

Constructor Detail

SonarComponents

public SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory,
                       org.sonar.api.batch.fs.FileSystem fs,
                       JavaClasspath javaClasspath,
                       JavaTestClasspath javaTestClasspath,
                       org.sonar.api.batch.rule.CheckFactory checkFactory)

SonarComponents

public SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory,
                       org.sonar.api.batch.fs.FileSystem fs,
                       JavaClasspath javaClasspath,
                       JavaTestClasspath javaTestClasspath,
                       org.sonar.api.batch.rule.CheckFactory checkFactory,
                       @Nullable
                       CheckRegistrar[] checkRegistrars)

Will be called in SonarLint context when custom rules are present

SonarComponents

public SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory,
                       org.sonar.api.batch.fs.FileSystem fs,
                       JavaClasspath javaClasspath,
                       JavaTestClasspath javaTestClasspath,
                       org.sonar.api.batch.rule.CheckFactory checkFactory,
                       @Nullable
                       org.sonar.api.batch.bootstrap.ProjectDefinition projectDefinition)

Will be called in SonarScanner context when no custom rules is present

SonarComponents

public SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory,
                       org.sonar.api.batch.fs.FileSystem fs,
                       JavaClasspath javaClasspath,
                       JavaTestClasspath javaTestClasspath,
                       org.sonar.api.batch.rule.CheckFactory checkFactory,
                       @Nullable
                       CheckRegistrar[] checkRegistrars,
                       @Nullable
                       org.sonar.api.batch.bootstrap.ProjectDefinition projectDefinition)

ProjectDefinition class is not available in SonarLint context, so this constructor will never be called when using SonarLint

Method Detail

setSensorContext

public void setSensorContext(org.sonar.api.batch.sensor.SensorContext context)

fileLinesContextFor

public org.sonar.api.measures.FileLinesContext fileLinesContextFor(org.sonar.api.batch.fs.InputFile inputFile)

symbolizableFor

public org.sonar.api.batch.sensor.symbol.NewSymbolTable symbolizableFor(org.sonar.api.batch.fs.InputFile inputFile)

highlightableFor

public org.sonar.api.batch.sensor.highlighting.NewHighlighting highlightableFor(org.sonar.api.batch.fs.InputFile inputFile)

getJavaClasspath

public List<File> getJavaClasspath()

getJavaTestClasspath

public List<File> getJavaTestClasspath()

registerCheckClasses

public void registerCheckClasses(String repositoryKey,
                                 Iterable<Class<? extends JavaCheck>> checkClasses)

checkClasses

public JavaCheck[] checkClasses()

checks

public Iterable<org.sonar.api.batch.rule.Checks<JavaCheck>> checks()

registerTestCheckClasses

public void registerTestCheckClasses(String repositoryKey,
                                     Iterable<Class<? extends JavaCheck>> checkClasses)

testCheckClasses

public Collection<JavaCheck> testCheckClasses()

getRuleKey

public org.sonar.api.rule.RuleKey getRuleKey(JavaCheck check)

addIssue

public void addIssue(org.sonar.api.batch.fs.InputComponent inputComponent,
                     JavaCheck check,
                     int line,
                     String message,
                     @Nullable
                     Integer cost)

reportIssue

public void reportIssue(AnalyzerMessage analyzerMessage)

reportAnalysisError

public boolean reportAnalysisError(com.sonar.sslr.api.RecognitionException re,
                                   org.sonar.api.batch.fs.InputFile inputFile)

reportAnalysisError

public void reportAnalysisError(org.sonar.api.batch.fs.InputFile inputFile,
                                String message)

isSonarLintContext

public boolean isSonarLintContext()

fileLines

public List<String> fileLines(org.sonar.api.batch.fs.InputFile inputFile)

inputFileContents

public String inputFileContents(org.sonar.api.batch.fs.InputFile inputFile)

analysisCancelled

public boolean analysisCancelled()

addAnalysisError

public void addAnalysisError(AnalysisError analysisError)

saveAnalysisErrors

public void saveAnalysisErrors()

shouldFailAnalysisOnException

public boolean shouldFailAnalysisOnException()

workDir

public File workDir()

baseDir

public File baseDir()

project

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