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
-
- Direct Known Subclasses:
AcuCobol.Descriptor
,Ajc.Descriptor
,AndroidLint.Descriptor
,AnsibleLint.Descriptor
,ArmCc.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
,CodeNarc.Descriptor
,Coolflux.Descriptor
,Cpd.Descriptor
,CppCheck.Descriptor
,CppLint.Descriptor
,CssLint.Descriptor
,Detekt.Descriptor
,DiabC.Descriptor
,DocFx.Descriptor
,DockerLint.Descriptor
,Doxygen.Descriptor
,DrMemory.Descriptor
,DScanner.Descriptor
,DupFinder.Descriptor
,Eclipse.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
,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
,PcLint.Descriptor
,Pep8.Descriptor
,Perforce.Descriptor
,PerlCritic.Descriptor
,Php.Descriptor
,PhpCodeSniffer.Descriptor
,PhpStan.Descriptor
,Pit.Descriptor
,Pmd.Descriptor
,PreFast.Descriptor
,ProtoLint.Descriptor
,PuppetLint.Descriptor
,PVSStudio.Descriptor
,PyDocStyle.Descriptor
,PyLint.Descriptor
,QacSourceCodeAnalyser.Descriptor
,QtTranslation.Descriptor
,ResharperInspectCode.Descriptor
,RfLint.Descriptor
,Robocopy.Descriptor
,RuboCop.Descriptor
,Scala.Descriptor
,Simian.Descriptor
,SonarQube.Descriptor
,SphinxBuild.Descriptor
,StyleCop.Descriptor
,SunC.Descriptor
,SwiftLint.Descriptor
,TagList.Descriptor
,TaskingVx.Descriptor
,TiCss.Descriptor
,Tnsdl.Descriptor
,Trivy.Descriptor
,TsLint.Descriptor
,WarningsPlugin.Descriptor
,Xlc.Descriptor
,XmlLint.Descriptor
,YamlLint.Descriptor
,YuiCompressor.Descriptor
,ZptLint.Descriptor
- Enclosing class:
- AnalysisModelParser
public abstract static class AnalysisModelParser.AnalysisModelParserDescriptor extends ReportScanningTool.ReportScanningToolDescriptor
Descriptor forAnalysisModelParser
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
-
-
Field Summary
-
Fields inherited from class hudson.model.Descriptor
clazz
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AnalysisModelParserDescriptor(String id)
Creates a new instance ofAnalysisModelParser.AnalysisModelParserDescriptor
with the given ID.protected
AnalysisModelParserDescriptor(String id, String descriptionId)
Creates a new instance ofAnalysisModelParser.AnalysisModelParserDescriptor
with the given ID.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.protected DescriptionProvider
getDescriptionProvider()
Returns a description provider to obtain detailed issue descriptions.String
getDisplayName()
String
getHelp()
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.StaticAnalysisLabelProvider
getLabelProvider()
Returns aStaticAnalysisLabelProvider
that will render all tool specific labels.String
getPattern()
Returns the default filename pattern for this tool.String
getUrl()
Returns an optional URL to the homepage of the static analysis tool.-
Methods inherited from class io.jenkins.plugins.analysis.core.model.ReportScanningTool.ReportScanningToolDescriptor
canScanConsoleLog, doCheckPattern, doCheckReportEncoding, doFillReportEncodingItems, hasDefaultPattern
-
Methods inherited from class io.jenkins.plugins.analysis.core.model.Tool.ToolDescriptor
doCheckId, getId, getName, getSymbolName, isPostProcessingEnabled
-
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
-
-
-
-
Constructor Detail
-
AnalysisModelParserDescriptor
protected AnalysisModelParserDescriptor(String id)
Creates a new instance ofAnalysisModelParser.AnalysisModelParserDescriptor
with the given ID.- Parameters:
id
- the unique ID of the tool
-
AnalysisModelParserDescriptor
protected AnalysisModelParserDescriptor(String id, String descriptionId)
Creates a new instance ofAnalysisModelParser.AnalysisModelParserDescriptor
with the given ID.- Parameters:
id
- the unique ID of the tooldescriptionId
- the description ID of the tool in the analysis model module
-
-
Method Detail
-
getLabelProvider
public StaticAnalysisLabelProvider getLabelProvider()
Returns aStaticAnalysisLabelProvider
that will render all tool specific labels.- Overrides:
getLabelProvider
in classTool.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 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 classReportScanningTool.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 classTool.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 classTool.ToolDescriptor
- Returns:
- the help
-
getDisplayName
@NonNull public final String getDisplayName()
- Overrides:
getDisplayName
in classDescriptor<Tool>
-
-