annotations/com.sahsenvar.kmapper.annotations/OnFail

OnFail

Brokenness policy for a failed conversion. Absence is ALWAYS type-driven (nullable/default) — never a policy.

Fallback ladder, in order: converted > default > null/not-a-member > error. A sanctioned null — an OrNull converter variant declaring "this input has no legitimate counterpart" (see MapTypeConverter) — is legitimate flow, not a failure, so it is exempt even under Throw. Skip applies to collection elements only.

Entries

Auto

Follow the fallback ladder (default): converted > default > null/not-a-member > error.

Throw

Harden brokenness: a failed conversion is a hard error even with a declared escape. Sanctioned nulls (MapTypeConverter OrNull variants) still pass — they are not failures.

Skip

Collection elements only: drop the failed element instead of null-in-place (reported).

Properties

entries

val entries: EnumEntries<OnFail>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): OnFail

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<OnFail>

Returns an array containing the constants of this enum type, in the order they're declared.