Package com.puppycrawl.tools.checkstyle

Record Class SarifLogger.RuleKey

java.lang.Object
java.lang.Record
com.puppycrawl.tools.checkstyle.SarifLogger.RuleKey
Record Components:
sourceName - The fully qualified source class name.
moduleId - The module ID from configuration (can be null).
Enclosing class:
SarifLogger
private static record SarifLogger.RuleKey(String sourceName, String moduleId) extends Record
Composite key for uniquely identifying a rule by source name and module ID.

  • Field Details

  • Constructor Details

    • RuleKey

      private RuleKey(String sourceName, String moduleId)
      Creates an instance of a RuleKey record class.
      Parameters:
      sourceName - the value for the sourceName record component
      moduleId - the value for the moduleId record component

  • Method Details

    • toRuleId

      private String toRuleId()
      Converts this key to a SARIF rule ID string.
      Returns:
      rule ID in format: sourceName[#moduleId]

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • sourceName

      public String sourceName()
      Returns the value of the sourceName record component.
      Returns:
      the value of the sourceName record component

    • moduleId

      public String moduleId()
      Returns the value of the moduleId record component.
      Returns:
      the value of the moduleId record component