Package io.jenkins.plugins.analysis.warnings

Class GrepParser.Descriptor

java.lang.Object

hudson.model.Descriptor<Tool>

io.jenkins.plugins.analysis.core.model.Tool.ToolDescriptor

io.jenkins.plugins.analysis.warnings.GrepParser.Descriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

GrepParser

@Symbol("grepParser")
@Extension
public static class GrepParser.Descriptor
extends Tool.ToolDescriptor

Descriptor for this static analysis tool.

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

Constructor	Description
Descriptor()	Creates the descriptor instance.

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckExample(BuildableItem project, String example, String regexp, String severity, String message)	Validates the example text against the configured regexp (live preview in the UI).
FormValidation	doCheckExcludePattern(AbstractProject<?,?> project, String excludePattern)	Performs on-the-fly validation on the ant pattern for excluded files.
FormValidation	doCheckIncludePattern(AbstractProject<?,?> project, String includePattern)	Performs on-the-fly validation on the ant pattern for included files.
FormValidation	doCheckRegexp(BuildableItem project, String regexp)	Performs on-the-fly validation on the regular expression.
ListBoxModel	doFillSeverityItems()	Returns the available severity levels for the drop-down in the UI.
String	getDisplayName()
StaticAnalysisLabelProvider	getLabelProvider()	Returns a StaticAnalysisLabelProvider that will render all tool specific labels.

Methods inherited from class io.jenkins.plugins.analysis.core.model.Tool.ToolDescriptor

doCheckId, getHelp, getIcon, getId, getName, getSymbolName, getUrl, isPostProcessingEnabled

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, 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, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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 Details

Descriptor

public Descriptor()

Creates the descriptor instance.

Method Details

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Tool>

getLabelProvider

public StaticAnalysisLabelProvider getLabelProvider()

Description copied from class: Tool.ToolDescriptor

Returns a StaticAnalysisLabelProvider that will render all tool specific labels.

Overrides:

getLabelProvider in class Tool.ToolDescriptor

Returns:

a tool specific StaticAnalysisLabelProvider

doCheckIncludePattern

@POST
public FormValidation doCheckIncludePattern(@AncestorInPath
 AbstractProject<?,?> project,
 @QueryParameter
 String includePattern)

Performs on-the-fly validation on the ant pattern for included files.

Parameters:

project - the project that is configured

includePattern - the file pattern

Returns:

the validation result

doCheckExcludePattern

@POST
public FormValidation doCheckExcludePattern(@AncestorInPath
 AbstractProject<?,?> project,
 @QueryParameter
 String excludePattern)

Performs on-the-fly validation on the ant pattern for excluded files.

Parameters:

project - the project that is configured

excludePattern - the file pattern

Returns:

the validation result

doCheckRegexp

@POST
public FormValidation doCheckRegexp(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 String regexp)

Performs on-the-fly validation on the regular expression.

Parameters:

project - the project that is configured

regexp - the regular expression to validate

Returns:

the validation result

doFillSeverityItems

@POST
public ListBoxModel doFillSeverityItems()

Returns the available severity levels for the drop-down in the UI.

Returns:

a list-box model with all predefined severity options

doCheckExample

@POST
public FormValidation doCheckExample(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 String example,
 @QueryParameter
 String regexp,
 @QueryParameter
 String severity,
 @QueryParameter
 String message)

Validates the example text against the configured regexp (live preview in the UI). The message template is also applied so that captured groups can be verified.

Parameters:

project - the project that is configured

example - example text to scan

regexp - the regular expression to match

severity - the severity to assign to matches

message - the optional message template; when blank the matched line is used as-is

Returns:

validation result