Package org.sonarsource.slang.externalreport

Class CheckstyleFormatImporterWithRuleLoader

  • public class CheckstyleFormatImporterWithRuleLoader
extends CheckstyleFormatImporter
    Import external linter reports having "Checkstyle" xml format into SonarQube. Use an "ExternalRuleLoader" to define type/severity/effort of each issue.

    • Constructor Summary

      Constructors 
      Constructor Description
      CheckstyleFormatImporterWithRuleLoader​(org.sonar.api.batch.sensor.SensorContext context, java.lang.String linterKey, org.sonarsource.analyzer.commons.ExternalRuleLoader externalRuleLoader)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.Long effort​(java.lang.String ruleKey)
      Return an Effort value based on the ruleKey.
      protected org.sonar.api.rules.RuleType ruleType​(java.lang.String ruleKey, java.lang.String severity, java.lang.String source)
      Return a RuleType equivalent based on the different parameters.
      protected org.sonar.api.batch.rule.Severity severity​(java.lang.String ruleKey, java.lang.String severity)
      Return a Severity equivalent based on the different parameters.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CheckstyleFormatImporterWithRuleLoader

        public CheckstyleFormatImporterWithRuleLoader​(org.sonar.api.batch.sensor.SensorContext context,
                                              java.lang.String linterKey,
                                              org.sonarsource.analyzer.commons.ExternalRuleLoader externalRuleLoader)
        Parameters:
        context - , the context where issues will be sent
        linterKey - , used to specify the rule repository
        externalRuleLoader - , used to define type/severity/effort of issues

    • Method Detail

      • ruleType

        protected org.sonar.api.rules.RuleType ruleType​(java.lang.String ruleKey,
                                                @Nullable
                                                java.lang.String severity,
                                                java.lang.String source)
        Description copied from class: CheckstyleFormatImporter
        Return a RuleType equivalent based on the different parameters.
        Overrides:
        ruleType in class CheckstyleFormatImporter
        Parameters:
        ruleKey - rule key of the current issue.
        severity - "severity" attribute's value of the report. Ex: "info", "error".
        source - "source" attribute's value of the report. Ex: "gosec", "detekt.MagicNumber".
        Returns:
        the RuleType defined by the given parameters.

      • severity

        protected org.sonar.api.batch.rule.Severity severity​(java.lang.String ruleKey,
                                                     @Nullable
                                                     java.lang.String severity)
        Description copied from class: CheckstyleFormatImporter
        Return a Severity equivalent based on the different parameters.
        Overrides:
        severity in class CheckstyleFormatImporter
        Parameters:
        ruleKey - rule key of the current issue.
        severity - "severity" attribute's value of the report. Ex: "info", "error".
        Returns:
        the Severity defined by the given parameters.

      • effort

        protected java.lang.Long effort​(java.lang.String ruleKey)
        Description copied from class: CheckstyleFormatImporter
        Return an Effort value based on the ruleKey.
        Overrides:
        effort in class CheckstyleFormatImporter
        Parameters:
        ruleKey - rule key of the current issue.
        Returns:
        the Effort defined by the given ruleKey.