Class OpenTasks
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<Tool>
-
- io.jenkins.plugins.analysis.core.model.Tool
-
- io.jenkins.plugins.analysis.warnings.tasks.OpenTasks
-
- All Implemented Interfaces:
Describable<Tool>
,Serializable
public class OpenTasks extends Tool
Provides a files scanner that detects open tasks in source code files.- Author:
- Ullrich Hafner
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OpenTasks.Descriptor
Descriptor for this static analysis tool.-
Nested classes/interfaces inherited from class io.jenkins.plugins.analysis.core.model.Tool
Tool.ToolDescriptor
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getExcludePattern()
Returns the Ant file-set pattern of files to exclude from work.String
getHighTags()
Returns the high priority tag identifiers.boolean
getIgnoreCase()
Returns whether case should be ignored during the scanning.String
getIncludePattern()
Returns the Ant file-set pattern of files to work with.boolean
getIsRegularExpression()
Returns whether the identifiers should be treated as regular expression.String
getLowTags()
Returns the low priority tag identifiers.String
getNormalTags()
Returns the normal priority tag identifiers.edu.hm.hafner.analysis.Report
scan(Run<?,?> run, FilePath workspace, Charset sourceCodeEncoding, LogHandler logger)
Scans the results of a build for issues.void
setExcludePattern(String excludePattern)
void
setHighTags(String highTags)
void
setIgnoreCase(boolean ignoreCase)
void
setIncludePattern(String includePattern)
void
setIsRegularExpression(boolean isRegularExpression)
void
setLowTags(String lowTags)
void
setNormalTags(String normalTags)
-
Methods inherited from class io.jenkins.plugins.analysis.core.model.Tool
getActualId, getActualName, getDescriptor, getId, getLabelProvider, getName, getSymbolName, readResolve, setId, setJenkinsFacade, setName
-
-
-
-
Constructor Detail
-
OpenTasks
@DataBoundConstructor public OpenTasks()
Creates a new instance ofOpenTasks
.
-
-
Method Detail
-
getIncludePattern
public String getIncludePattern()
Returns the Ant file-set pattern of files to work with.- Returns:
- Ant file-set pattern of files to work with
-
setIncludePattern
@DataBoundSetter public void setIncludePattern(String includePattern)
-
getExcludePattern
public String getExcludePattern()
Returns the Ant file-set pattern of files to exclude from work.- Returns:
- Ant file-set pattern of files to exclude from work
-
setExcludePattern
@DataBoundSetter public void setExcludePattern(String excludePattern)
-
getHighTags
public String getHighTags()
Returns the high priority tag identifiers.- Returns:
- the high priority tag identifiers
-
setHighTags
@DataBoundSetter public void setHighTags(String highTags)
-
getNormalTags
public String getNormalTags()
Returns the normal priority tag identifiers.- Returns:
- the normal priority tag identifiers
-
setNormalTags
@DataBoundSetter public void setNormalTags(String normalTags)
-
getLowTags
public String getLowTags()
Returns the low priority tag identifiers.- Returns:
- the low priority tag identifiers
-
setLowTags
@DataBoundSetter public void setLowTags(String lowTags)
-
getIgnoreCase
public boolean getIgnoreCase()
Returns whether case should be ignored during the scanning.- Returns:
true
if case should be ignored during the scanning
-
setIgnoreCase
@DataBoundSetter public void setIgnoreCase(boolean ignoreCase)
-
getIsRegularExpression
public boolean getIsRegularExpression()
Returns whether the identifiers should be treated as regular expression.- Returns:
true
if the identifiers should be treated as regular expression
-
setIsRegularExpression
@DataBoundSetter public void setIsRegularExpression(boolean isRegularExpression)
-
scan
public edu.hm.hafner.analysis.Report scan(Run<?,?> run, FilePath workspace, Charset sourceCodeEncoding, LogHandler logger)
Description copied from class:Tool
Scans the results of a build for issues. This method is invoked on Jenkins master. I.e., if a tool wants to process some build results it is required to run aMasterToSlaveCallable
.
-
-