Record Class Violation

java.lang.Object

java.lang.Record

dev.archunitjava.result.Violation

All Implemented Interfaces:

Comparable<Violation>

public record Violation(ViolationId id, String code, Severity severity, List<ViolationSubject> subjects, List<DependencyEvidence> evidence, Map<String,String> attributes)
extends Record
implements Comparable<Violation>

Structured architecture-rule failure data, with no renderer-owned prose.

Constructor Summary

Constructors

Constructor	Description
Violation(ViolationId id, String code, Severity severity, List<ViolationSubject> subjects, List<DependencyEvidence> evidence, Map<String,String> attributes)	Creates an instance of a Violation record class.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	Returns the value of the attributes record component.
String	code()	Returns the value of the code record component.
int	compareTo(Violation other)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<DependencyEvidence>	evidence()	Returns the value of the evidence record component.
final int	hashCode()	Returns a hash code value for this object.
ViolationId	id()	Returns the value of the id record component.
Severity	severity()	Returns the value of the severity record component.
List<ViolationSubject>	subjects()	Returns the value of the subjects record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Violation

public Violation(ViolationId id,
 String code,
 Severity severity,
 List<ViolationSubject> subjects,
 List<DependencyEvidence> evidence,
 Map<String,String> attributes)

Creates an instance of a Violation record class.

Parameters:

id - the value for the id record component

code - the value for the code record component

severity - the value for the severity record component

subjects - the value for the subjects record component

evidence - the value for the evidence record component

attributes - the value for the attributes record component

Method Details

compareTo

public int compareTo(Violation other)

Specified by:

compareTo in interface Comparable<Violation>

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.

id

public ViolationId id()

Returns the value of the id record component.

Returns:

the value of the id record component

code

public String code()

Returns the value of the code record component.

Returns:

the value of the code record component

severity

public Severity severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

subjects

public List<ViolationSubject> subjects()

Returns the value of the subjects record component.

Returns:

the value of the subjects record component

evidence

public List<DependencyEvidence> evidence()

Returns the value of the evidence record component.

Returns:

the value of the evidence record component

attributes

public Map<String,String> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component