Record Class Diagnostic

java.lang.Object

java.lang.Record

dev.archunitjava.result.Diagnostic

All Implemented Interfaces:

Comparable<Diagnostic>

public record Diagnostic(String code, Severity severity, Map<String,String> context)
extends Record
implements Comparable<Diagnostic>

Structured analysis or execution information that renderers may later turn into prose.

Constructor Summary

Constructors

Constructor	Description
Diagnostic(String code, Severity severity, Map<String,String> context)	Creates an instance of a Diagnostic record class.

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the value of the code record component.
int	compareTo(Diagnostic other)
Map<String,String>	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Severity	severity()	Returns the value of the severity 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

Diagnostic

public Diagnostic(String code,
 Severity severity,
 Map<String,String> context)

Creates an instance of a Diagnostic record class.

Parameters:

code - the value for the code record component

severity - the value for the severity record component

context - the value for the context record component

Method Details

compareTo

public int compareTo(Diagnostic other)

Specified by:

compareTo in interface Comparable<Diagnostic>

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.

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

context

public Map<String,String> context()

Returns the value of the context record component.

Returns:

the value of the context record component