Package io.jenkins.plugins.analysis.core.model

Class AnalysisModelParser.AnalysisModelParserDescriptor

java.lang.Object
hudson.model.Descriptor<Tool>
io.jenkins.plugins.analysis.core.model.Tool.ToolDescriptor
io.jenkins.plugins.analysis.core.model.ReportScanningTool.ReportScanningToolDescriptor
io.jenkins.plugins.analysis.core.model.AnalysisModelParser.AnalysisModelParserDescriptor
All Implemented Interfaces:
Saveable, Loadable, OnMaster
Direct Known Subclasses:
AcuCobol.Descriptor, Ajc.Descriptor, AndroidLint.Descriptor, AnsibleLint.Descriptor, AquaScanner.Descriptor, ArmCc.Descriptor, BluePearl.Descriptor, Brakeman.Descriptor, Buckminster.Descriptor, Cadence.Descriptor, Cargo.Descriptor, Ccm.Descriptor, CheckStyle.Descriptor, Clair.Descriptor, Clang.Descriptor, ClangAnalyzer.Descriptor, ClangTidy.Descriptor, Cmake.Descriptor, CodeAnalysis.Descriptor, CodeChecker.Descriptor, CodeGenerator.Descriptor, CodeNarc.Descriptor, Coolflux.Descriptor, Cpd.Descriptor, CppCheck.Descriptor, CppLint.Descriptor, CrossCoreEmbeddedStudio.Descriptor, CssLint.Descriptor, Dart.Descriptor, Detekt.Descriptor, DiabC.Descriptor, DocFx.Descriptor, DockerLint.Descriptor, Doxygen.Descriptor, DrMemory.Descriptor, DScanner.Descriptor, DupFinder.Descriptor, Eclipse.Descriptor, EmbeddedEngineer.Descriptor, Erlc.Descriptor, ErrorProne.Descriptor, EsLint.Descriptor, FindBugs.FindBugsDescriptor, Flake8.Descriptor, Flawfinder.Descriptor, FlexSdk.Descriptor, Fxcop.Descriptor, Gcc3.Descriptor, Gcc4.Descriptor, Gendarme.Descriptor, GhsMulti.Descriptor, Gnat.Descriptor, GnuFortran.Descriptor, GoLint.Descriptor, GoVet.Descriptor, Grype.Descriptor, HadoLint.Descriptor, Iar.Descriptor, IarCstat.Descriptor, IbLinter.Descriptor, IdeaInspection.Descriptor, Infer.Descriptor, Intel.Descriptor, Invalids.Descriptor, Java.Descriptor, JavaDoc.Descriptor, JcReport.Descriptor, JsHint.Descriptor, JsLint.Descriptor, JUnit.Descriptor, KlocWork.Descriptor, Kotlin.Descriptor, KtLint.Descriptor, MavenConsole.Descriptor, MentorGraphics.Descriptor, MetrowerksCodeWarrior.Descriptor, MsBuild.Descriptor, MyPy.Descriptor, NagFortran.Descriptor, OELintAdv.Descriptor, OTDockerLint.Descriptor, OwaspDependencyCheck.Descriptor, PcLint.Descriptor, Pep8.Descriptor, Perforce.Descriptor, PerlCritic.Descriptor, Php.Descriptor, PhpCodeSniffer.Descriptor, PhpStan.Descriptor, Pit.Descriptor, Pmd.Descriptor, Polyspace.Descriptor, PreFast.Descriptor, ProtoLint.Descriptor, PuppetLint.Descriptor, PVSStudio.Descriptor, PyDocStyle.Descriptor, PyLint.Descriptor, QacSourceCodeAnalyser.Descriptor, QtTranslation.Descriptor, ResharperInspectCode.Descriptor, RevApi.Descriptor, RfLint.Descriptor, Robocopy.Descriptor, RuboCop.Descriptor, Sarif.Descriptor, Scala.Descriptor, Simian.Descriptor, SimulinkCheck.Descriptor, SonarQube.Descriptor, SphinxBuild.Descriptor, StyleCop.Descriptor, StyleLint.Descriptor, SunC.Descriptor, SwiftLint.Descriptor, TagList.Descriptor, TaskingVx.Descriptor, TiCss.Descriptor, Tnsdl.Descriptor, Trivy.Descriptor, TsLint.Descriptor, VeraCodePipelineScanner.Descriptor, WarningsPlugin.Descriptor, Xlc.Descriptor, XmlLint.Descriptor, YamlLint.Descriptor, YoctoScanner.Descriptor, YuiCompressor.Descriptor, ZptLint.Descriptor
Enclosing class:
AnalysisModelParser
public abstract static class AnalysisModelParser.AnalysisModelParserDescriptor extends ReportScanningTool.ReportScanningToolDescriptor
Descriptor for AnalysisModelParser.

  • Constructor Details

  • Method Details

    • getLabelProvider

      public StaticAnalysisLabelProvider getLabelProvider()
      Returns a StaticAnalysisLabelProvider that will render all tool specific labels.
      Overrides:
      getLabelProvider in class Tool.ToolDescriptor
      Returns:
      a tool specific StaticAnalysisLabelProvider

    • getDescriptionProvider

      protected DescriptionProvider getDescriptionProvider()
      Returns a description provider to obtain detailed issue descriptions.
      Returns:
      a description provider

    • createParser

      public edu.hm.hafner.analysis.IssueParser createParser(edu.hm.hafner.analysis.registry.ParserDescriptor.Option... options)
      Returns a new parser to scan a log file and return the issues reported in such a file.
      Parameters:
      options - options to configure the parser - may customize the new parser instance (if supported by the selected tool)
      Returns:
      the parser to use

    • getPattern

      public String getPattern()
      Description copied from class: ReportScanningTool.ReportScanningToolDescriptor
      Returns the default filename pattern for this tool. Override if your parser typically works on a specific file. Note: if you provide a default pattern, then it is not possible to scan Jenkins' console log of a build.
      Overrides:
      getPattern in class ReportScanningTool.ReportScanningToolDescriptor
      Returns:
      the default pattern

    • getHelp

      public String getHelp()
      Description copied from class: Tool.ToolDescriptor
      Returns an optional help text that can provide useful hints on how to configure the static analysis tool so that the report files could be parsed by Jenkins. This help can be a plain text message or an HTML snippet.
      Overrides:
      getHelp in class Tool.ToolDescriptor
      Returns:
      the help

    • getUrl

      public String getUrl()
      Description copied from class: Tool.ToolDescriptor
      Returns an optional URL to the homepage of the static analysis tool.
      Overrides:
      getUrl in class Tool.ToolDescriptor
      Returns:
      the help

    • getDisplayName

      @NonNull public final String getDisplayName()
      Overrides:
      getDisplayName in class Descriptor<Tool>