ihawu-core/org.ihawu.core.masking/MaskingCapability

MaskingCapability

enum MaskingCapability : Enum<MaskingCapability>

How a single field may be masked so the output still satisfies the field's declared type contract.

Derived once per type from two serialization-neutral facts about the declared field — textual-or-not and nullable-or-not — which together decide what each strategy may do: REDACT depends on textual-vs-not (a placeholder for text, JSON null for a nullable non-text field, rejected otherwise); HIDE depends only on nullability (see omittable). A serialization backend computes these two facts from its own type system and calls of; nothing here references a serialization library.

Entries

TEXTUAL_REQUIRED

Textual, non-null. REDACT -> placeholder; HIDE -> reject (omitting a required field breaks the schema).

TEXTUAL_OPTIONAL

Textual, nullable. REDACT -> placeholder; HIDE -> omit.

NULLABLE

Non-textual, nullable. REDACT -> JSON null; HIDE -> omit.

UNSAFE

Non-textual, non-null. No contract-safe masked form exists; both strategies reject.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<MaskingCapability>

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

name

expect val name: String

omittable

val omittable: Boolean

HIDE: whether this field may be omitted without breaking the declared schema.

ordinal

expect val ordinal: Int

Functions

redactDecision

fun redactDecision(placeholder: String): MaskingDecision

The MaskingDecision for a REDACT policy on this field, given its resolved placeholder: the placeholder for a textual field, JSON null for a nullable non-textual field, or a fail-closed MaskingDecision.Omit when no contract-safe value exists.

unenforceableReason

fun unenforceableReason(strategy: MaskingStrategy): FailReason?

Why strategy cannot be honoured on this field, or null if it can. The single predicate shared by the runtime engine and the startup validator, so they agree by construction.

valueOf

fun valueOf(value: String): MaskingCapability

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

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