KaDiagnostic¶

The human-readable message rendered by the compiler to describe the error, warning, or info.

A technical name identifying the diagnostic.

This is the same name as reported by the compiler when the -Xrender-internal-diagnostic-names compiler flag is enabled.

Example

fun test() {
    foo(1)
}

Because foo is not defined, the compiler reports an UNRESOLVED_REFERENCE error. This would also be the factoryName of the KaDiagnostic.

Whether the diagnostic is suppressed at its use site, e.g., by a @Suppress annotation.

Suppressed diagnostics are not reported by the compiler, so they should not be presented to the user as is. By default, diagnostic collection filters them out; KaDiagnostics.ignoreSuppressed yields them as well.

The property is only meaningful for diagnostics obtained from diagnostic collection. For diagnostics obtained in another way, such as diagnostics of an unresolved call, the property is always false.

Example

@Suppress("UNUSED_VARIABLE")
fun foo() {
    val unused = 0
}

The UNUSED_VARIABLE diagnostic reported on unused is suppressed.

The severity of the diagnostic (e.g. error or warning), which is determined from the compiler's classification of the diagnostic.

The KaLifetimeToken which determines the lifetime of the lifetime owner.

Returns a formatted string of the diagnostic's factory name and default message.

Whether the lifetime owner is still valid, i.e. we are still in the scope of the lifetime owner's regular lifetime.

Executes action only if the KaLifetimeOwner is still valid and accessible. Otherwise, throws a validity exception based on the concrete violation.