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:
  • Constructor Details

    • OpenTasks

      @DataBoundConstructor public OpenTasks()
      Creates a new instance of OpenTasks.
  • Method Details

    • 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 a MasterToSlaveCallable.
      Specified by:
      scan in class Tool
      Parameters:
      run - the build
      workspace - the workspace of the build
      sourceCodeEncoding - the encoding to use to read source files
      logger - the logger
      Returns:
      the created report