Record Class Check

java.lang.Object

java.lang.Record

com.thirtysevenaudits.auditor.Check

public record Check(CheckStatus status, String resource, String message, String recommendation, int score, Map<String,Object> data)
extends Record

Constructor Summary

Constructors

Constructor	Description
Check(CheckStatus status, String resource, String message, String recommendation, int score, Map<String,Object> data)	Creates an instance of a Check record class.

Method Summary

Modifier and Type	Method	Description
static Check	convertFailToWarning(Check c)
static long	countStatus(Collection<Check> checks, CheckStatus status)
Map<String,Object>	data()	Returns the value of the data 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	message()	Returns the value of the message record component.
String	recommendation()	Returns the value of the recommendation record component.
String	resource()	Returns the value of the resource record component.
int	score()	Returns the value of the score record component.
CheckStatus	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Check

public Check(CheckStatus status,
 String resource,
 String message,
 String recommendation,
 int score,
 Map<String,Object> data)

Creates an instance of a Check record class.

Parameters:

status - the value for the status record component

resource - the value for the resource record component

message - the value for the message record component

recommendation - the value for the recommendation record component

score - the value for the score record component

data - the value for the data record component

Method Details

countStatus

public static long countStatus(Collection<Check> checks,
 CheckStatus status)

convertFailToWarning

public static Check convertFailToWarning(Check c)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

status

public CheckStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component

resource

public String resource()

Returns the value of the resource record component.

Returns:

the value of the resource record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

recommendation

public String recommendation()

Returns the value of the recommendation record component.

Returns:

the value of the recommendation record component

score

public int score()

Returns the value of the score record component.

Returns:

the value of the score record component

data

public Map<String,Object> data()

Returns the value of the data record component.

Returns:

the value of the data record component