Package cdc.issues

Class IssueId

java.lang.Object
cdc.issues.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 Details

    • 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.

    • getHash

      public String getHash()
      Returns a SHA1 digest of this id, computed from a string built as:
      {domain}/{name}[{name}={value},...]{project}[{location},...]

      Characters are converted to UTF8 stream.

      Returns:
      A SHA1 digest of this id.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(IssueId other)
      Specified by:
      compareTo in interface Comparable<IssueId>

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static IssueId.Builder builder()