Modul edu.hm.hafner.analysis.model
Package edu.hm.hafner.analysis.registry

Klasse ParserDescriptor

java.lang.Object
edu.hm.hafner.analysis.registry.ParserDescriptor
Bekannte direkte Unterklassen:
DryDescriptor
public abstract class ParserDescriptor extends Object
Interface to describe all descriptors.
Autor:
Lorenz Munsch

  • Methodendetails

    • getId

      public String getId()
      Returns the technical ID of the parser.
      Gibt zurück:
      the technical id of the parser

    • getName

      public String getName()
      Returns a human-readable name of the parser. Note that this property is not yet localizable.
      Gibt zurück:
      the human-readable name

    • createParser

      public abstract IssueParser createParser(ParserDescriptor.Option... options)
      Creates a new IssueParser instance.
      Parameter:
      options - options to configure the parser - may customize the new parser instance (if supported by the selected tool)
      Gibt zurück:
      the parser

    • getPattern

      public String getPattern()
      Returns the default filename pattern for this tool. Override if your parser typically works on a specific file. This pattern will be interpreted as an ANT pattern or glob, resp.
      Gibt zurück:
      the default pattern

    • 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.
      Gibt zurück:
      the help

    • hasHelp

      public final boolean hasHelp()
      Returns whether an optional help text is available for this parser.
      Gibt zurück:
      true if there is a help text available
      Siehe auch:

    • getUrl

      public String getUrl()
      Returns an optional URL to the homepage of the static analysis tool.
      Gibt zurück:
      the help

    • hasUrl

      public final boolean hasUrl()
      Returns whether the URL for the parser is set.
      Gibt zurück:
      true if there is a URL available
      Siehe auch:

    • getIconUrl

      public String getIconUrl()
      Returns an optional URL to the icon or logo of the static analysis tool.
      Gibt zurück:
      the help

    • getDescription

      public String getDescription(Issue issue)
      Returns a detailed description of the specified issue. If there is no additional description is available, then an empty String is returned.
      Parameter:
      issue - the issue to get the description for
      Gibt zurück:
      the description