Package io.jenkins.plugins.analysis.warnings.tasks

Class OpenTasks.Descriptor

java.lang.Object

hudson.model.Descriptor<Tool>

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

io.jenkins.plugins.analysis.warnings.tasks.OpenTasks.Descriptor

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

OpenTasks

@Symbol("taskScanner")
@Extension
public static class OpenTasks.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(AbstractProject<?,?> project, String example, String high, String normal, String low, boolean ignoreCase, boolean asRegexp)	Validates the example text that will be scanned for open tasks.
FormValidation	doCheckExcludePattern(AbstractProject<?,?> project, String excludePattern)	Performs on-the-fly validation on the ant pattern for input files.
FormValidation	doCheckIncludePattern(AbstractProject<?,?> project, String includePattern)	Performs on-the-fly validation on the ant pattern for input files.
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, getId, 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, 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

Descriptor

public Descriptor()

Creates the descriptor instance.

Method Detail

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 input 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 input files.

Parameters:

project - the project that is configured

excludePattern - the file pattern

Returns:

the validation result

doCheckExample

@POST
public FormValidation doCheckExample(@AncestorInPath
                                     AbstractProject<?,?> project,
                                     @QueryParameter
                                     String example,
                                     @QueryParameter
                                     String high,
                                     @QueryParameter
                                     String normal,
                                     @QueryParameter
                                     String low,
                                     @QueryParameter
                                     boolean ignoreCase,
                                     @QueryParameter
                                     boolean asRegexp)

Validates the example text that will be scanned for open tasks.

Parameters:

project - the project that is configured

example - the text to be scanned for open tasks

high - tag identifiers indicating high priority

normal - tag identifiers indicating normal priority

low - tag identifiers indicating low priority

ignoreCase - if case should be ignored during matching

asRegexp - if the identifiers should be treated as regular expression

Returns:

validation result