serialkompat-core/com.chrisjenx.serialkompat.core/Finding

Finding

data class Finding(val rule: String, val direction: CompatibilityDirection, val severity: Severity, val contract: String, val detail: String, val message: String, val fixHint: String?, val change: Change)

A classified compatibility judgment about a single Change in a single direction: the rule it triggered, its severity, and human-facing text.

direction is always CompatibilityDirection.BACKWARD or CompatibilityDirection.FORWARD — never FULL — because a FULL check is evaluated as its two constituent directions, each of which can differ.

Constructors

constructor(rule: String, direction: CompatibilityDirection, severity: Severity, contract: String, detail: String, message: String, fixHint: String?, change: Change)

Properties

val change: Change

The underlying structural change this finding was derived from.

val contract: String

Serial name of the affected contract (or the config key for config changes).

val detail: String

What changed, e.g. field 'amount'.

val direction: CompatibilityDirection

val fixHint: String?

A concrete suggestion for keeping compatibility, if any.

val message: String

Human explanation of the change and why it matters in this direction.

val rule: String

val severity: Severity

Functions

fun Finding.findAcceptedBy(accepted: List<AcceptedBreak>): AcceptedBreak?

The first entry in accepted that sanctions this finding, or null if none does.

fun Finding.isAcceptedBy(accepted: List<AcceptedBreak>): Boolean

Whether this finding is sanctioned by any entry in accepted.