simboot-core-annotation/love.forte.simboot.annotation

Package-level declarations

Types

AnnotationEventFilter

interface ~~AnnotationEventFilter~~ : EventFilter

应用于 love.forte.simboot.annotation.Filter 注解上用来直接处理对应注解的函数。

AnnotationEventFilterFactory

interface AnnotationEventFilterFactory

应用于 @Filter 注解上的 Filter.by 参数，用于通过参数构建一个当前 Filter 对应的过滤器实例。

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])

annotation class Binder(val value: Array<String> = [], val scope: Binder.Scope = Scope.DEFAULT)

标记在一个函数上。假如这个函数不存在 Listener, 则说明这个函数是一个 love.forte.simboot.listener.ParameterBinderFactory 的函数体，此时函数有且只能有一个参数 love.forte.simboot.listener.ParameterBinderFactory.Context, 且返回值必须为 love.forte.simboot.listener.ParameterBinderResult.

BlockingAnnotationEventFilter

interface ~~BlockingAnnotationEventFilter~~ : AnnotationEventFilter, BlockingEventFilter

应用于 love.forte.simboot.annotation.Filter 注解上用来直接处理对应注解的函数。

@ExperimentalSimbotApi

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class ContentToNull(val priority: Int = PriorityConstant.FIRST)

对 EventListenerProcessingContext.textContent 进行前置处理, 使 textContent 结果始终为null。

@ExperimentalSimbotApi

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class ContentTrim(val priority: Int = PriorityConstant.FIRST)

对 EventListenerProcessingContext.textContent 进行前置处理, 清除前后空格（如果不为null的话）。

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class CurrentBinder

Binder.scope 为 Binder.Scope.CURRENT 的 Binder.

@Repeatable(value = Filters::class)

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Filter(val value: String = "", val ifNullPass: Boolean = false, val matchType: MatchType = MatchType.REGEX_MATCHES, val targets: Filter.Targets = Targets(), val by: KClass<out AnnotationEventFilterFactory> = AnnotationEventFilterFactory::class)

与 @Listener 配合使用，会被解析为对应监听函数的通用属性过滤器。

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Filters(val value: Filter, val multiMatchType: MultiFilterMatchType = MultiFilterMatchType.ANY)

多个子过滤器的容器。一个 Filters 最终会表现为一个汇总过滤器。

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class FilterValue(val value: String, val required: Boolean = true)

指定一个参数，此参数为通过 love.forte.simboot.filter.Keyword 解析而得到的动态参数提取器中的内容。

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class GlobalBinder

Binder.scope 为 Binder.Scope.GLOBAL 的 Binder.

@Repeatable(value = Interceptors::class)

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Interceptor(val value: String = "", val type: KClass<out AnnotatedEventListenerInterceptor> = AnnotatedEventListenerInterceptor::class, val priority: Int = PriorityConstant.NORMAL)

配合 Listener 使用，为一个监听函数指定一个或多个注解型监听函数拦截器.

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Interceptors(val value: Interceptor)

Interceptor 的可重复容器.

@Repeatable(value = Listens::class)

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Listen(val value: KClass<out Event>)

标记于一个函数上，代表它们所表示的监听函数应当要监听的事件类型集。

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Listener(val id: String = "", val priority: Int = PriorityConstant.NORMAL, val async: Boolean = false)

标记一个函数为监听器/监听函数，并尝试自动检测其监听类型。

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Listens(val value: Listen)

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class MessageValue(val isReversed: Boolean = false)

@Repeatable(value = Preparers::class)

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Preparer(val value: KClass<out ListenerPreparer>, val name: String = "", val priority: Int = PriorityConstant.NORMAL)

配合 @Listener 注解使用，标记需要在监听函数执行前进行的准备函数。

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.ANNOTATION_CLASS])

annotation class Preparers(val value: Preparer)

Preparer 的容器

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])

annotation class SpecifyBinder(val value: Array<String>)

Binder.scope 为 Binder.Scope.SPECIFY 的 Binder.

Functions

inline fun Binder.scopeIfDefault(block: () -> Binder.Scope): Binder.Scope