Class RuleResult

java.lang.Object

dev.archunitjava.result.RuleResult

All Implemented Interfaces:

Comparable<RuleResult>

public final class RuleResult
extends Object
implements Comparable<RuleResult>

Immutable result of one rule evaluation, with an explicit non-overlapping terminal state.

Method Summary

Modifier and Type	Method	Description
int	compareTo(RuleResult other)
List<Diagnostic>	diagnostics()
boolean	equals(Object other)
static RuleResult	failed(RuleMetadata metadata, List<Violation> violations, List<Diagnostic> diagnostics)
static RuleResult	failed(String ruleId, List<Violation> violations, List<Diagnostic> diagnostics)
int	hashCode()
static RuleResult	incomplete(RuleMetadata metadata, List<Violation> violations, List<Diagnostic> diagnostics)
static RuleResult	incomplete(String ruleId, List<Violation> violations, List<Diagnostic> diagnostics)
RuleMetadata	metadata()
boolean	passed()
static RuleResult	passed(RuleMetadata metadata)
static RuleResult	passed(RuleMetadata metadata, List<Diagnostic> diagnostics)
static RuleResult	passed(String ruleId)
static RuleResult	passed(String ruleId, List<Diagnostic> diagnostics)
String	ruleId()
static RuleResult	skipped(RuleMetadata metadata, List<Diagnostic> diagnostics)
static RuleResult	skipped(String ruleId, List<Diagnostic> diagnostics)
RuleStatus	status()
String	toString()
List<Violation>	violations()

Methods inherited from class Object

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

Method Details

passed

public static RuleResult passed(String ruleId)

passed

public static RuleResult passed(String ruleId,
 List<Diagnostic> diagnostics)

passed

public static RuleResult passed(RuleMetadata metadata)

passed

public static RuleResult passed(RuleMetadata metadata,
 List<Diagnostic> diagnostics)

failed

public static RuleResult failed(String ruleId,
 List<Violation> violations,
 List<Diagnostic> diagnostics)

failed

public static RuleResult failed(RuleMetadata metadata,
 List<Violation> violations,
 List<Diagnostic> diagnostics)

skipped

public static RuleResult skipped(String ruleId,
 List<Diagnostic> diagnostics)

skipped

public static RuleResult skipped(RuleMetadata metadata,
 List<Diagnostic> diagnostics)

incomplete

public static RuleResult incomplete(String ruleId,
 List<Violation> violations,
 List<Diagnostic> diagnostics)

incomplete

public static RuleResult incomplete(RuleMetadata metadata,
 List<Violation> violations,
 List<Diagnostic> diagnostics)

ruleId

public String ruleId()

metadata

public RuleMetadata metadata()

status

public RuleStatus status()

violations

public List<Violation> violations()

diagnostics

public List<Diagnostic> diagnostics()

passed

public boolean passed()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(RuleResult other)

Specified by:

compareTo in interface Comparable<RuleResult>

toString

public String toString()

Overrides:

toString in class Object