Class Tool

    • Constructor Detail

      • Tool

        public Tool()
    • Method Detail

      • setJenkinsFacade

        public void setJenkinsFacade​(io.jenkins.plugins.util.JenkinsFacade jenkinsFacade)
      • readResolve

        protected Object readResolve()
        Called after de-serialization to retain backward compatibility.
        Returns:
        this
      • setId

        @DataBoundSetter
        public void setId​(String id)
        Overrides the default ID of the results. The ID is used as URL of the results and as identifier in UI elements. If no ID is given, then the default ID is used, see corresponding Tool.ToolDescriptor.
        Parameters:
        id - the ID of the results
        See Also:
        Tool.ToolDescriptor.getId()
      • getId

        public String getId()
      • setName

        @DataBoundSetter
        public void setName​(String name)
        Overrides the name of the results. The name is used for all labels in the UI. If no name is given, then the default name is used, see corresponding Tool.ToolDescriptor.
        Parameters:
        name - the name of the results
        See Also:
        Tool.ToolDescriptor.getName()
      • getName

        public String getName()
      • getSymbolName

        public String getSymbolName()
        Returns the Symbol name of this tool.
        Returns:
        the name of this tool, or "undefined" if no symbol has been defined
      • getLabelProvider

        public StaticAnalysisLabelProvider getLabelProvider()
        Returns the associated label provider for this tool.
        Returns:
        the label provider
      • scan

        public abstract edu.hm.hafner.analysis.Report scan​(Run<?,​?> run,
                                                           FilePath workspace,
                                                           Charset sourceCodeEncoding,
                                                           LogHandler logger)
                                                    throws edu.hm.hafner.analysis.ParsingException,
                                                           edu.hm.hafner.analysis.ParsingCanceledException
        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.
        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
        Throws:
        edu.hm.hafner.analysis.ParsingException - Signals that during parsing a non recoverable error has been occurred
        edu.hm.hafner.analysis.ParsingCanceledException - Signals that the parsing has been aborted by the user