Record Class Violation

java.lang.Object

java.lang.Record

ca.mcscert.jpipe.model.Violation

public record Violation(String rule, String message, SourceLocation location)
extends Record

A single rule violation found during consistency or completeness validation.

rule is a stable kebab-case identifier (e.g. "no-duplicate-ids") that callers can use for filtering or localisation. message is a human-readable description. location is the source position of the offending element, or SourceLocation.UNKNOWN when the model was built programmatically without location tracking.

Constructor Summary

Constructors

Constructor	Description
Violation(String rule, String message, SourceLocation location)	Creates an instance of a Violation record class.

Method Summary

Modifier and Type	Method	Description
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.
SourceLocation	location()	Returns the value of the location record component.
String	message()	Returns the value of the message record component.
String	rule()	Returns the value of the rule 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(String rule,
 String message,
 SourceLocation location)

Creates an instance of a Violation record class.

Parameters:

rule - the value for the rule record component

message - the value for the message record component

location - the value for the location record component

Method Details

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.

rule

public String rule()

Returns the value of the rule record component.

Returns:

the value of the rule record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

location

public SourceLocation location()

Returns the value of the location record component.

Returns:

the value of the location record component