Package org.sonar.java

Class SonarComponents

  • @ScannerSide
@SonarLintSide
public class SonarComponents
extends Object

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

      • inputFromIOFileOrDirectory

        @Deprecated
@Nullable
public org.sonar.api.batch.fs.InputComponent inputFromIOFileOrDirectory​(File file)
        Deprecated.
        since SonarJava 5.12 - dropping usage of file to rely on InputComponent/InputFile
        DEPRECATED: Method to retrieve the corresponding IssueComponent from a file. As File-based API should not be used anymore, this is deprecated and will be dropped.

      • inputFromIOFile

        @Deprecated
@Nullable
public org.sonar.api.batch.fs.InputFile inputFromIOFile​(File file)
        Deprecated.
        since SonarJava 5.12 - dropping usage of file to rely on InputComponent/InputFile
        DEPRECATED: As file should not be used anymore, this is deprecated and will be dropped. InputFile/InputComponent should always be available in the context of a scan, and so no reason to still rely on File.

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

      • checkClasses

        public JavaCheck[] checkClasses()

      • registerTestCheckClasses

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

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