event-library/com.smushytaco.event_library.internal/ExceptionSignatureKind

ExceptionSignatureKind

internal enum ExceptionSignatureKind : Enum<ExceptionSignatureKind>

Enumerates the supported method signatures for @ExceptionHandler methods.

Each enum entry corresponds to one of the valid shapes an exception handler method may take. Signatures are matched polymorphically: a parameter typed as a supertype of the actual event or exception is still considered compatible.

Constructors

private constructor()

Entries

EVENT_AND_THROWABLE

Represents an exception handler method with two parameters:

EVENT_ONLY

Represents an exception handler method with a single event parameter:

THROWABLE_ONLY

Represents an exception handler method with a single throwable parameter:

Types

Companion

object Companion

Companion object providing the extension that inspects a reflective Method and determines whether it represents a supported exception handler signature.

Properties

entries

val entries: EnumEntries<ExceptionSignatureKind>

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

name

val name: String

ordinal

val ordinal: Int

Functions

getEventClass

fun getEventClass(method: Method): Class<out Event>

Resolves the logical event type associated with this exception-handler signature.

getThrowableType

fun getThrowableType(method: Method): Class<out Throwable>?

Extracts the declared throwable parameter type from an exception–handler method, when applicable.

valueOf

fun valueOf(value: String): ExceptionSignatureKind

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

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