inspekt/dev.rnett.inspekt.model/Parameter

Parameter

data class Parameter : AnnotatedElement(source)

A parameter of a function or other callable declaration.

Types

enum Kind : Enum<Parameter.Kind>

The kind of a parameter.

Properties

open override val allAnnotations: List<AnnotationInfo>

All annotations on this element with their source information.

open override val annotations: List<Annotation>

All annotations on this element, including inherited ones.

declaredAnnotations

open override val declaredAnnotations: List<Annotation>

Annotations declared directly on this element.

val globalIndex: Int

The global index of the parameter in the list of all parameters.

val hasDefault: Boolean

Whether the parameter has a default value.

val indexInKind: Int

The index of the parameter in the list of parameters of its Kind.

val kind: Parameter.Kind

The kind of the parameter: dispatch, context, extension, or value.

val name: String

The parameter's name.

val type: KType

The parameter's type.

Functions

inline fun <T> AnnotatedElement.annotation(): T?

Get the first annotation of type T, or null if none is found.

inline fun <T> AnnotatedElement.annotations(): List<T>

Get all annotations of type T.

fun checkValue(value: Any?)

Throws an exception if the parameter cannot accept the given value. Not throwing does not guarantee acceptance (although it typically will be accepted).

possiblyAcceptsValue

fun possiblyAcceptsValue(value: Any?): Boolean

Returns true if the parameter can possibly accept the given value. Returning true does not guarantee acceptance (although it typically will be accepted), but returning false does guarantee rejection.

open override fun toString(): String