Record Class SourceDocumentId

java.lang.Object
java.lang.Record
dev.archunitjava.metrics.SourceDocumentId
All Implemented Interfaces:
StableId, Comparable<StableId>
public record SourceDocumentId(JavaPackageName packageName, SourceFileName fileName) extends Record implements StableId
Package-qualified source identity; a bare SourceFile attribute is never treated as a path.

  • Constructor Details

    • SourceDocumentId

      public SourceDocumentId(JavaPackageName packageName, SourceFileName fileName)
      Creates an instance of a SourceDocumentId record class.
      Parameters:
      packageName - the value for the packageName record component
      fileName - the value for the fileName record component

  • Method Details

    • stableKey

      public String stableKey()
      Specified by:
      stableKey in interface StableId

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

    • packageName

      public JavaPackageName packageName()
      Returns the value of the packageName record component.
      Returns:
      the value of the packageName record component

    • fileName

      public SourceFileName fileName()
      Returns the value of the fileName record component.
      Returns:
      the value of the fileName record component