Record Class Finding

java.lang.Object

java.lang.Record

com.shaft.doctor.model.Finding

Record Components:

id - stable finding identifier

kind - whether this is an observation or inference

category - associated cause category

severity - finding severity

title - concise title

detail - safe explanatory detail

ruleId - rule that emitted the finding

evidenceIds - cited evidence identifiers

public record Finding(String id, Finding.Kind kind, CauseCategory category, Finding.Severity severity, String title, String detail, String ruleId, List<String> evidenceIds)
extends Record

Cited observation or inference emitted by a rule.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Finding.Kind	Finding epistemic type.
static enum	Finding.Severity	Finding severity.

Constructor Summary

Constructors

Constructor	Description
Finding(String id, Finding.Kind kind, CauseCategory category, Finding.Severity severity, String title, String detail, String ruleId, List<String> evidenceIds)	Creates a validated finding.

Method Summary

Modifier and Type	Method	Description
CauseCategory	category()	Returns the value of the category record component.
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.
List<String>	evidenceIds()	Returns the value of the evidenceIds record component.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
Finding.Kind	kind()	Returns the value of the kind record component.
String	ruleId()	Returns the value of the ruleId record component.
Finding.Severity	severity()	Returns the value of the severity record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Finding

public Finding(String id,
 Finding.Kind kind,
 CauseCategory category,
 Finding.Severity severity,
 String title,
 String detail,
 String ruleId,
 List<String> evidenceIds)

Creates a validated finding.

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.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

kind

public Finding.Kind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

category

public CauseCategory category()

Returns the value of the category record component.

Returns:

the value of the category record component

severity

public Finding.Severity severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

detail

public String detail()

Returns the value of the detail record component.

Returns:

the value of the detail record component

ruleId

public String ruleId()

Returns the value of the ruleId record component.

Returns:

the value of the ruleId record component

evidenceIds

public List<String> evidenceIds()

Returns the value of the evidenceIds record component.

Returns:

the value of the evidenceIds record component