Package org.sentrysoftware.metricshub.engine.strategy.detection

Class CriterionTestResult

java.lang.Object

org.sentrysoftware.metricshub.engine.strategy.detection.CriterionTestResult

public class CriterionTestResult
extends Object

Represents the result of a criterion test, including information about success, failure, or errors.

Constructor Summary

Constructors

Constructor	Description
CriterionTestResult()

Method Summary

Modifier and Type	Method	Description
String	displayCriterionMessage()	Formats and displays the criterion message in a structured, readable format.
static CriterionTestResult	empty()	Creates an empty criterion test result.
static CriterionTestResult	error(Criterion criterion, String reason)	Create a detection error report.
static CriterionTestResult	error(Criterion criterion, String reason, Throwable t)	Create a detection error report.
static CriterionTestResult	error(Criterion criterion, Throwable t)	Create a detection error report.
static CriterionTestResult	failure(Criterion criterion, String result)	Create a detection failure report.
static CriterionTestResult	success(Criterion criterion, String result)	Create a successful detection report.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CriterionTestResult

public CriterionTestResult()

Method Details

empty

public static CriterionTestResult empty()

Creates an empty criterion test result.

Returns:

A new CriterionTestResult instance.

failure

public static CriterionTestResult failure(Criterion criterion,
 String result)

Create a detection failure report.

Parameters:

criterion - The failed criterion

result - Its result (that doesn't match with the criterion)

Returns:

a new CriterionTestResult instance

error

public static CriterionTestResult error(Criterion criterion,
 String reason,
 Throwable t)

Create a detection error report.

Parameters:

criterion - The failed criterion

reason - The reason why it failed

t - the Exception that made the test fail

Returns:

a new CriterionTestResult instance

error

public static CriterionTestResult error(Criterion criterion,
 String reason)

Create a detection error report.

Parameters:

criterion - The failed criterion

reason - The reason why it failed

Returns:

a new CriterionTestResult instance

error

public static CriterionTestResult error(Criterion criterion,
 Throwable t)

Create a detection error report.

Parameters:

criterion - The failed criterion

t - the Exception that made the test fail

Returns:

a new CriterionTestResult instance

success

public static CriterionTestResult success(Criterion criterion,
 String result)

Create a successful detection report.

Parameters:

criterion - The criterion that was fulfilled

result - Its result

Returns:

a new CriterionTestResult instance

displayCriterionMessage

public String displayCriterionMessage()

Formats and displays the criterion message in a structured, readable format. The output includes information about the executed criterion, its details, the result, and an additional message, each presented in distinct sections.

Returns:

a formatted string that displays the criterion name, details, result, and message.