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

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

All Implemented Interfaces:

Saveable, OnMaster

Direct Known Subclasses:

AnalysisModelParser.AnalysisModelParserDescriptor, GroovyScript.Descriptor, RegisteredParser.Descriptor

Enclosing class:

ReportScanningTool

public static class ReportScanningTool.ReportScanningToolDescriptor
extends Tool.ToolDescriptor

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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReportScanningToolDescriptor(String id)	Creates a new instance of ReportScanningTool.ReportScanningToolDescriptor with the given ID.

Method Summary

Modifier and Type	Method	Description
boolean	canScanConsoleLog()	Returns whether this parser can scan the console log.
FormValidation	doCheckPattern(AbstractProject<?,?> project, String pattern)	Performs on-the-fly validation on the ant pattern for input files.
FormValidation	doCheckReportEncoding(AbstractProject<?,?> project, String reportEncoding)	Performs on-the-fly validation of the character encoding.
ComboBoxModel	doFillReportEncodingItems(AbstractProject<?,?> project)	Returns a model with all available charsets.
String	getPattern()	Returns the default filename pattern for this tool.
boolean	hasDefaultPattern()	Indicates whether or not this scanning tool has a default pattern.

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, 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, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportScanningToolDescriptor

protected ReportScanningToolDescriptor(String id)

Creates a new instance of ReportScanningTool.ReportScanningToolDescriptor with the given ID.

Parameters:

id - the unique ID of the tool

Method Detail

doFillReportEncodingItems

@POST
public ComboBoxModel doFillReportEncodingItems(@AncestorInPath
                                               AbstractProject<?,?> project)

Returns a model with all available charsets.

Parameters:

project - the project that is configured

Returns:

a model with all available charsets

doCheckReportEncoding

@POST
public FormValidation doCheckReportEncoding(@AncestorInPath
                                            AbstractProject<?,?> project,
                                            @QueryParameter
                                            String reportEncoding)

Performs on-the-fly validation of the character encoding.

Parameters:

project - the project that is configured

reportEncoding - 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 configured

pattern - the file pattern

Returns:

the validation result

hasDefaultPattern

public boolean hasDefaultPattern()

Indicates whether or not this scanning tool has a default pattern. 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

public String getPattern()

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.

Returns:

the default pattern