Package org.monarchinitiative.lirical.core.sanitize

Record Class SanityIssue

java.lang.Object

java.lang.Record

org.monarchinitiative.lirical.core.sanitize.SanityIssue

Record Components:

level - severity of the issue.

message - description of the issue for humans.

solution - the proposed solution or null if N/A.

public record SanityIssue(SanityLevel level, String message, String solution)
extends Record

An issue that was found in the analysis input.

Author:

Daniel Danis

Constructor Summary

Constructors

Constructor	Description
SanityIssue(SanityLevel level, String message, String solution)	Creates an instance of a SanityIssue record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static SanityIssue	error(String message, String solution)
final int	hashCode()	Returns a hash code value for this object.
SanityLevel	level()	Returns the value of the level record component.
String	message()	Returns the value of the message record component.
String	solution()	Returns the value of the solution record component.
final String	toString()	Returns a string representation of this record class.
static SanityIssue	warning(String message, String solution)

Methods inherited from class java.lang.Object

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

Constructor Details

SanityIssue

public SanityIssue(SanityLevel level,
 String message,
 String solution)

Creates an instance of a SanityIssue record class.

Parameters:

level - the value for the level record component

message - the value for the message record component

solution - the value for the solution record component

Method Details

error

public static SanityIssue error(String message,
 String solution)

warning

public static SanityIssue warning(String message,
 String solution)

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.

level

public SanityLevel level()

Returns the value of the level record component.

Returns:

the value of the level record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

solution

public String solution()

Returns the value of the solution record component.

Returns:

the value of the solution record component