Class ReportScanningTool

    • Constructor Detail

      • ReportScanningTool

        public ReportScanningTool()
    • Method Detail

      • setPattern

        @DataBoundSetter
        public void setPattern​(String pattern)
        Sets the Ant file-set pattern of files to work with. If the pattern is undefined then the console log is scanned.
        Parameters:
        pattern - the pattern to use
      • getPattern

        @CheckForNull
        public String getPattern()
      • createParser

        public abstract edu.hm.hafner.analysis.IssueParser createParser()
        Returns a new parser to scan a log file and return the issues reported in such a file.
        Returns:
        the parser to use
      • setSkipSymbolicLinks

        @DataBoundSetter
        public void setSkipSymbolicLinks​(boolean skipSymbolicLinks)
        Specify if file scanning skip traversal of symbolic links.
        Parameters:
        skipSymbolicLinks - if symbolic links should be skipped during directory scanning.
      • getSkipSymbolicLinks

        public boolean getSkipSymbolicLinks()
      • setReportEncoding

        @DataBoundSetter
        public void setReportEncoding​(String reportEncoding)
        Sets the encoding to use to read the log files that contain the warnings.
        Parameters:
        reportEncoding - the encoding, e.g. "ISO-8859-1"
      • getReportEncoding

        @CheckForNull
        public String getReportEncoding()
      • 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