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
static String	FAIL_ON_EXCEPTION_KEY
static String	SONAR_BATCH_MODE_KEY

Constructor Summary

Constructors

Constructor	Description
SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory, org.sonar.api.batch.fs.FileSystem fs, ClasspathForMain javaClasspath, ClasspathForTest javaTestClasspath, org.sonar.api.batch.rule.CheckFactory checkFactory)
SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory, org.sonar.api.batch.fs.FileSystem fs, ClasspathForMain javaClasspath, ClasspathForTest 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, ClasspathForMain javaClasspath, ClasspathForTest 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, ClasspathForMain javaClasspath, ClasspathForTest 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	addIssue(org.sonar.api.batch.fs.InputComponent inputComponent, JavaCheck check, int line, String message, Integer cost)
boolean	analysisCancelled()
void	collectUndefinedTypes(Set<String> undefinedTypes)
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()
List<File>	getJspClasspath()
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	isBatchModeEnabled()
boolean	isSonarLintContext()
List<JavaCheck>	jspChecks()
void	logUndefinedTypes()
List<JavaCheck>	mainChecks()
org.sonar.api.batch.fs.InputComponent	project()
void	registerMainCheckClasses(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	reportIssue(AnalyzerMessage analyzerMessage)
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)
List<JavaCheck>	testChecks()
File	workDir()

Methods inherited from class java.lang.Object

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

Field Details

FAIL_ON_EXCEPTION_KEY

public static final String FAIL_ON_EXCEPTION_KEY

See Also:

Constant Field Values

SONAR_BATCH_MODE_KEY

public static final String SONAR_BATCH_MODE_KEY

See Also:

Constant Field Values

Constructor Details

SonarComponents

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

SonarComponents

public SonarComponents(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory,
 org.sonar.api.batch.fs.FileSystem fs,
 ClasspathForMain javaClasspath,
 ClasspathForTest 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,
 ClasspathForMain javaClasspath,
 ClasspathForTest 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,
 ClasspathForMain javaClasspath,
 ClasspathForTest 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 Details

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()

getJspClasspath

public List<File> getJspClasspath()

registerMainCheckClasses

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

registerTestCheckClasses

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

mainChecks

public List<JavaCheck> mainChecks()

testChecks

public List<JavaCheck> testChecks()

jspChecks

public List<JavaCheck> jspChecks()

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)

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()

shouldFailAnalysisOnException

public boolean shouldFailAnalysisOnException()

isBatchModeEnabled

public boolean isBatchModeEnabled()

workDir

public File workDir()

project

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

collectUndefinedTypes

public void collectUndefinedTypes(Set<String> undefinedTypes)

logUndefinedTypes

public void logUndefinedTypes()