Class Defect

  • All Implemented Interfaces:

    
    public final class Defect
    
                        

    A data model for software defects.

    Instances of this class are created by advisor implementations that retrieve information about known defects in packages.

    • Method Detail

      • getId

         final String getId()

        The (external) ID of this defect. This is a string used by a concrete issue tracker system to reference this defect, such as a bug ID or ticket number.

      • getUrl

         final URI getUrl()

        The URL pointing to the source of this defect. This is typically a reference into the issue tracker system that contains this defect.

      • getTitle

         final String getTitle()

        A title for this defect if available. This is a short summary describing the problem at hand.

      • getState

         final String getState()

        A state of the associated defect if available. The concrete meaning of this string depends on the source from where it was obtained, as different issue tracker systems use their specific terminology. Possible values could be OPEN, IN PROGRESS, BLOCKED, etc.

      • getSeverity

         final String getSeverity()

        The severity assigned to the defect if available. The meaning of this string depends on the source system.

      • getDescription

         final String getDescription()

        An optional description of this defect. It can contain more detailed information about the defect and its impact. The field may be undefined if the url of this defect already points to a website with all this information.

      • getModificationTime

         final Instant getModificationTime()

        Contains a time when this defect has been modified the last time in the tracker system it has been obtained from. This information can be useful for instance to find out how up-to-date this defect report might be.

      • getClosingTime

         final Instant getClosingTime()

        Contains a time when this defect has been closed if it has been resolved already (and this information is available in the source system). For users of the component affected by this defect, this information can be of interest to find out whether a fix is available, maybe in a newer version.

      • getFixReleaseVersion

         final String getFixReleaseVersion()

        Contains the version of the release, in which this defect was fixed if available. This is important information for consumers of the component affected by the defect, so they can upgrade to this version.

      • getFixReleaseUrl

         final String getFixReleaseUrl()

        A URL pointing to the release, in which this defect was fixed if available. Depending on the information provided by a source, this URL could point to a website with detail information about the release, to release notes, or something like that. This information is important for consumers of the component affected by this defect, so they can upgrade to this release.

      • getLabels

         final Map<String, String> getLabels()

        A map with labels assigned to this defect. Labels provide a means frequently used by issue tracker systems to classify defects based on defined criteria. The exact meaning of these labels is depending on the source system.