BotCommands-core/io.github.freya022.botcommands.api.core/Executable

Executable

interface Executable(source)

Base class for any executable method (commands, components, modals...).

This never represents an aggregator.

Inheritors

ICommandOptionContainer

ICommandParameterContainer

ApplicationCommandInfo

TextCommandVariation

Properties

allOptions

open val allOptions: List<Option>

All options from this executable, including from its aggregates.

allOptionsOrdered

open val allOptionsOrdered: List<Option>

All options from this executable, including from its aggregates, sorted by order of appearance in this function.

context

abstract val context: BContext

The main context.

declaringClass

open val declaringClass: Class<*>

The class which declares the method of this executable.

declaringKClass

open val declaringKClass: KClass<*>

The class which declares the function of this executable.

function

abstract val function: KFunction<*>

The target function of this executable.

method

open val method: Method

The target method of this executable.

parameters

abstract val parameters: List<AggregatedParameter>

The parameters of this executable.

Functions

findAllAnnotations

open fun <A : Annotation> findAllAnnotations(annotationType: Class<out A>, directOverrides: Boolean): List<A>

Finds all annotations of type annotationType from this executable's function.

findAllAnnotations

inline fun <A : Annotation> Executable.findAllAnnotations(directOverrides: Boolean = true): List<A>

Finds all annotations of type A from this executable's function.

findAllAnnotationsWith

open fun <A : Annotation> findAllAnnotationsWith(annotationType: Class<out A>): List<MetaAnnotatedClass<out A>>

Finds all annotations meta-annotated with annotationType from this executable's function.

findAllAnnotationsWith

inline fun <A : Annotation> Executable.findAllAnnotationsWith(): List<MetaAnnotatedClass<A>>

Finds all annotations meta-annotated with A from this executable's function.

findAnnotation

open fun <A : Annotation> findAnnotation(annotationType: Class<out A>): A?

Finds a single annotation of type annotationType from this executable's function.

findAnnotation

inline fun <A : Annotation> Executable.findAnnotation(): A?

Finds a single annotation of type A from this executable's function.

getAllAnnotations

open fun getAllAnnotations(): List<Annotation>

Finds all annotations from this executable's function.

hasAnnotation

open fun hasAnnotation(annotationType: Class<out Annotation>): Boolean

Returns true if this element is annotated with annotationType.

hasAnnotation

inline fun <A : Annotation> Executable.hasAnnotation(): Boolean

Returns true if this element is annotated with A.