Package io.github.duckasteroid.agentdocs.publish.validation

Record Class ValidationResult

java.lang.Object

java.lang.Record

io.github.duckasteroid.agentdocs.publish.validation.ValidationResult

Record Components:

ruleId - stable rule identifier

severity - optional severity for non-pass outcomes

details - validation details or reasons (empty for pass)

public record ValidationResult(String ruleId, Optional<ValidationSeverity> severity, List<String> details)
extends Record

Result of evaluating a single validation rule.

Constructor Summary

Constructors

Constructor	Description
ValidationResult(String ruleId, Optional<ValidationSeverity> severity, List<String> details)	Creates an instance of a ValidationResult record class.

Method Summary

Modifier and Type	Method	Description
List<String>	details()	Returns the value of the details record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ValidationResult	error(String ruleId, String detail)	Creates an error result.
final int	hashCode()	Returns a hash code value for this object.
static ValidationResult	pass(String ruleId)	Creates a pass result with no severity.
String	ruleId()	Returns the value of the ruleId record component.
Optional<ValidationSeverity>	severity()	Returns the value of the severity record component.
final String	toString()	Returns a string representation of this record class.
static ValidationResult	warn(String ruleId, String detail)	Creates a warning result.

Methods inherited from class java.lang.Object

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

Constructor Details

ValidationResult

public ValidationResult(String ruleId,
 Optional<ValidationSeverity> severity,
 List<String> details)

Creates an instance of a ValidationResult record class.

Parameters:

ruleId - the value for the ruleId record component

severity - the value for the severity record component

details - the value for the details record component

Method Details

pass

public static ValidationResult pass(String ruleId)

Creates a pass result with no severity.

Parameters:

ruleId - rule identifier

Returns:

pass result

error

public static ValidationResult error(String ruleId,
 String detail)

Creates an error result.

Parameters:

ruleId - rule identifier

detail - error detail

Returns:

error result

warn

public static ValidationResult warn(String ruleId,
 String detail)

Creates a warning result.

Parameters:

ruleId - rule identifier

detail - warning detail

Returns:

warning result

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.

ruleId

public String ruleId()

Returns the value of the ruleId record component.

Returns:

the value of the ruleId record component

severity

public Optional<ValidationSeverity> severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

details

public List<String> details()

Returns the value of the details record component.

Returns:

the value of the details record component