Record Class ViolationSubject

java.lang.Object
java.lang.Record
dev.archunitjava.result.ViolationSubject
All Implemented Interfaces:
Comparable<ViolationSubject>
public record ViolationSubject(String role, StableId id) extends Record implements Comparable<ViolationSubject>
A typed architecture subject and its machine-readable role in a violation.

  • Constructor Details

    • ViolationSubject

      public ViolationSubject(String role, StableId id)
      Creates an instance of a ViolationSubject record class.
      Parameters:
      role - the value for the role record component
      id - the value for the id record component

  • Method Details

    • compareTo

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

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

    • role

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

    • id

      public StableId id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component