BotCommands/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

Properties

Link copied to clipboard
open val allOptions: List<Option>

All options from this executable, including from its aggregates.

Link copied to clipboard
open val allOptionsOrdered: List<Option>

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

Link copied to clipboard
abstract val context: BContext

The main context.

Link copied to clipboard
abstract val function: KFunction<*>

The target function of this executable.

Link copied to clipboard
abstract val parameters: List<AggregatedParameter>

The parameters of this executable.

Functions

Link copied to clipboard
open fun <A : Annotation> findAllAnnotations(annotationType: Class<out A>, rootOverride: Boolean): List<A>

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

Link copied to clipboard
inline fun <A : Annotation> Executable.findAllAnnotations(rootOverride: Boolean = true): List<A>

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

Link copied to clipboard
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.

Link copied to clipboard
inline fun <A : Annotation> Executable.findAllAnnotationsWith(): List<MetaAnnotatedClass<A>>

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

Link copied to clipboard
open fun <A : Annotation> findAnnotation(annotationType: Class<out A>): A?

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

Link copied to clipboard
inline fun <A : Annotation> Executable.findAnnotation(): A?

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

Link copied to clipboard
open fun getAllAnnotations(): List<Annotation>

Finds all annotations from this executable's function.

Link copied to clipboard
open fun getOptionByDeclaredName(name: String): Option?

Returns the option with the supplied declared name (i.e., name of the method parameter), or null if not found.

Link copied to clipboard
abstract fun getParameter(declaredName: String): AggregatedParameter?

Returns the aggregated parameter with the supplied declared name (i.e., name of the method parameter), or null if not found.

Link copied to clipboard
open fun hasAnnotation(annotationType: Class<out Annotation>): Boolean

Returns true if this element is annotated with annotationType.

Link copied to clipboard
inline fun <A : Annotation> Executable.hasAnnotation(): Boolean

Returns true if this element is annotated with A.