Package cdc.issues

Class IssueId

  • All Implemented Interfaces:
    Comparable<IssueId>

    public final class IssueId
    extends Object
    implements Comparable<IssueId>
    Data issue identifier.

    It is composed of:

    • a rule identifier (domain and rule name)
    • rule parameters
    • a project name
    • locations
    Note: several occurrences of issues may have the same identifier. They will differ by their snapshot.
    Author:
    Damien Carbonne
    • Method Detail

      • getRuleId

        public RuleId getRuleId()
        Returns:
        The rule identifier.
      • getDomain

        public String getDomain()
        Returns:
        The rule domain name (part of its identifier).
      • getName

        public String getName()
        Returns:
        The rule name (part of its identifier).
      • getName

        public <T extends Enum<T>> T getName​(Class<T> cls)
        Type Parameters:
        T - The enum type.
        Parameters:
        cls - The enum class.
        Returns:
        The rule name as an enum.
      • getParams

        public Params getParams()
        Returns:
        The parameters used to configure the rule.
      • getProject

        public String getProject()
        Returns:
        The project name (possibly null).
      • getLocations

        public Location[] getLocations()
        Returns:
        The locations related to the issue.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object