kotindia-core/io.github.kotindia/InvalidReason

InvalidReason

enum InvalidReason : Enum<InvalidReason> (source)

The reason a validator returned ValidationResult.Invalid.

Each value identifies the specific validation failure that was detected. Callers switching on InvalidReason should use an else branch to remain forward-compatible with new values added in future releases.

val result = PAN.validate("ABCDE1234F")
if (result is ValidationResult.Invalid) {
    when (result.reason) {
        InvalidReason.EMPTY          -> showError("Input is empty")
        InvalidReason.WRONG_LENGTH   -> showError("Wrong number of characters")
        InvalidReason.INVALID_FORMAT -> showError("Invalid character pattern")
        else                         -> showError("Validation failed: ${result.reason}")
    }
}

Samples

val result = Aadhaar.validate("000000000000")
check(result is ValidationResult.Invalid)
check(result.reason == InvalidReason.INVALID_PREFIX)

Entries

EMPTY

Input is blank or empty — validator received "" or a whitespace-only string.

WRONG_LENGTH

Input has the wrong character count for this document type (e.g., PAN must be exactly 10 chars).

INVALID_FORMAT

Input does not match the required character pattern (regex) for this document type.

INVALID_CHECKSUM

Input fails the document-specific checksum algorithm (Verhoeff for Aadhaar, Luhn for IMEI, GSTN for GSTIN).

INVALID_PREFIX

Input has an unrecognised prefix (e.g., pincode starting with 0, mobile not starting with 6–9).

INVALID_CATEGORY

Input encodes an invalid category code (e.g., PAN 4th character not in {P, C, H, A, B, G, J, L, F, T}).

Properties

entries

val entries: EnumEntries<InvalidReason>

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): InvalidReason

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<InvalidReason>

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