Class Tool.ToolDescriptor

    • Constructor Detail

      • ToolDescriptor

        protected ToolDescriptor​(String defaultId)
        Creates a new instance of Tool.ToolDescriptor with the given ID.
        Parameters:
        defaultId - the unique ID of the tool
    • Method Detail

      • doCheckId

        @POST
        public FormValidation doCheckId​(@AncestorInPath
                                        AbstractProject<?,​?> project,
                                        @QueryParameter
                                        String id)
        Performs on-the-fly validation of the ID.
        Parameters:
        project - the project that is configured
        id - the ID of the tool
        Returns:
        the validation result
      • getName

        public String getName()
        Returns the default name of this tool.
        Returns:
        the name
      • 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
      • getHelp

        public String getHelp()
        Returns an optional help text that can provide useful hints on how to configure the static analysis tool so that the report files could be parsed by Jenkins. This help can be a plain text message or an HTML snippet.
        Returns:
        the help
      • getUrl

        public String getUrl()
        Returns an optional URL to the homepage of the static analysis tool.
        Returns:
        the help
      • isPostProcessingEnabled

        public boolean isPostProcessingEnabled()
        Returns whether post processing on the agent is enabled for this tool. If enabled, for all issues absolute paths, fingerprints, packages and modules will be detected. Additionally, all affected files will be saved in the build so that these files can be shown in the UI later on.,
        Returns:
        true if post processing is enabled, false otherwise