ksp/dev.kord.codegen.ksp.annotations/AnnotationArguments

AnnotationArguments

class AnnotationArguments<A : Annotation>(source)

Container of the arguments of an KSAnnotation.

See also

Types

Link copied to clipboard
object Companion

Constructor functions for AnnotationArguments

Link copied to clipboard

Functions

Link copied to clipboard
@JvmName(name = "getEnum")
inline operator fun <T : Enum<T>> get(parameter: KProperty1<A, T>): T?
@JvmName(name = "getEnumArray")
inline operator fun <T : Enum<T>> get(parameter: KProperty1<A, Array<out T>>): List<T>?

@JvmName(name = "getNumber")
inline operator fun <T : Number> get(parameter: KProperty1<A, T>): T?

Returns the value of parameter as an Number or null if it is the default value (see NonNullAnnotationArguments for more information).

operator fun get(parameter: KProperty1<A, Annotation>): KSAnnotation?

Returns the value of parameter as an KSAnnotation or null if it is the default value (see NonNullAnnotationArguments for more information).

@JvmName(name = "getNumberArray")
inline operator fun <T : Number> get(parameter: KProperty1<A, Array<out T>>): List<T>?

Returns the value of parameter as a List of Numbers or null if it is the default value (see NonNullAnnotationArguments for more information).

@JvmName(name = "getAnnotationArray")
operator fun get(parameter: KProperty1<A, Array<out Annotation>>): List<KSAnnotation>?

Returns the value of parameter as a List of KSAnnotations or null if it is the default value (see NonNullAnnotationArguments for more information).

@JvmName(name = "getBooleanArray")
operator fun get(parameter: KProperty1<A, BooleanArray>): List<Boolean>?
@JvmName(name = "getStringArray")
operator fun get(parameter: KProperty1<A, Array<out String>>): List<String>?

Returns the value of parameter as a List of Strings or null if it is the default value (see NonNullAnnotationArguments for more information).

@JvmName(name = "getKClassArray")
operator fun get(parameter: KProperty1<A, Array<out KClass<*>>>): List<KSType>?

Returns the value of parameter as a List of KSTypes or null if it is the default value (see NonNullAnnotationArguments for more information).

@JvmName(name = "getBoolean")
operator fun get(parameter: KProperty1<A, Boolean>): Boolean?

Returns the value of parameter as an Boolean or null if it is the default value (see NonNullAnnotationArguments for more information).

@JvmName(name = "getString")
operator fun get(parameter: KProperty1<A, String>): String?

Returns the value of parameter as an String or null if it is the default value (see NonNullAnnotationArguments for more information).

@JvmName(name = "getKClass")
operator fun get(parameter: KProperty1<A, KClass<*>>): KSType?

Returns the value of parameter as an KSType or null if it is the default value (see NonNullAnnotationArguments for more information).

Link copied to clipboard
fun isDefault(parameter: KProperty1<A, Any>): Boolean

Checks whether the parameter uses its default value.

Link copied to clipboard
fun <A : Annotation> AnnotationArguments<A>.notNull(): AnnotationArguments.NonNullAnnotationArguments<A>

Not null accessors for this AnnotationArguments. See documentation of NonNullAnnotationArguments for more information.