Class ReportScanningTool.ReportScanningToolDescriptor
java.lang.Object
hudson.model.Descriptor<Tool>
io.jenkins.plugins.analysis.core.model.Tool.ToolDescriptor
io.jenkins.plugins.analysis.core.model.ReportScanningTool.ReportScanningToolDescriptor
- Direct Known Subclasses:
AnalysisModelParser.AnalysisModelParserDescriptor
,GroovyScript.Descriptor
,RegisteredParser.Descriptor
- Enclosing class:
ReportScanningTool
Descriptor for
ReportScanningTool
.- Author:
- Ullrich Hafner
-
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
ConstructorsModifierConstructorDescriptionprotected
Creates a new instance ofReportScanningTool.ReportScanningToolDescriptor
with the given ID. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether this parser can scan the console log.doCheckPattern
(AbstractProject<?, ?> project, String pattern) Performs on-the-fly validation on the ant pattern for input files.doCheckReportEncoding
(BuildableItem project, String reportEncoding) Performs on-the-fly validation of the character encoding.Returns a model with all available charsets.Returns the default filename pattern for this tool.boolean
Indicates whether this scanning tool has a default pattern, or not.Methods inherited from class io.jenkins.plugins.analysis.core.model.Tool.ToolDescriptor
doCheckId, getHelp, getId, getLabelProvider, getName, getSymbolName, getUrl, isPostProcessingEnabled
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
-
Constructor Details
-
ReportScanningToolDescriptor
Creates a new instance ofReportScanningTool.ReportScanningToolDescriptor
with the given ID.- Parameters:
id
- the unique ID of the tool
-
-
Method Details
-
doFillReportEncodingItems
Returns a model with all available charsets.- Returns:
- a model with all available charsets
-
doCheckReportEncoding
@POST public FormValidation doCheckReportEncoding(@AncestorInPath BuildableItem project, @QueryParameter String reportEncoding) Performs on-the-fly validation of the character encoding.- Parameters:
project
- the project that is configuredreportEncoding
- the character encoding- Returns:
- the validation result
-
doCheckPattern
@POST public FormValidation doCheckPattern(@AncestorInPath AbstractProject<?, ?> project, @QueryParameter String pattern) Performs on-the-fly validation on the ant pattern for input files.- Parameters:
project
- the project that is configuredpattern
- the file pattern- Returns:
- the validation result
-
hasDefaultPattern
public boolean hasDefaultPattern()Indicates whether this scanning tool has a default pattern, or not. If it does, it means it can never scan the console, but also means that we don't require a user-specified pattern as we have a usable default.- Returns:
- true if
getPattern()
returns a non-empty string.
-
canScanConsoleLog
public boolean canScanConsoleLog()Returns whether this parser can scan the console log. Typically, only line-based parsers can scan the console log. XML parsers should always parse a given file only.- Returns:
- the parser to use
-
getPattern
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.- Returns:
- the default pattern
-