Record Class Violation

java.lang.Object

java.lang.Record

ca.marcusdunn.jsonlens.testkit.Violation

Record Components:

rule - the rule

location - the location of the value, as a Normalized Path, for example $['a'][0]

detail - what the model did

public record Violation(Rule rule, String location, String detail)
extends Record

A value of a document that breaks a Rule.

Constructor Summary

Constructors

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

Method Summary

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

Creates an instance of a Violation record class.

Parameters:

rule - the value for the rule record component

location - the value for the location record component

detail - the value for the detail record component

Method Details

toString

public 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 Rule rule()

Returns the value of the rule record component.

Returns:

the value of the rule record component

location

public String location()

Returns the value of the location record component.

Returns:

the value of the location record component

detail

public String detail()

Returns the value of the detail record component.

Returns:

the value of the detail record component