BotCommands/io.github.freya022.botcommands.api.core.service.annotations

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS])

No-op annotation to mark a class / object as containing service factories.

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

annotation class BService(val name: String = "", val priority: Int = 0)

Marks this class as a service, or this function as a service factory. Can be added on your own annotation.

Condition

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])

annotation class Condition(val type: KClass<out CustomConditionChecker<*>>, val fail: Boolean = false)

Meta-annotation for custom conditions.

ConditionalService

@Inherited

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

annotation class ConditionalService(val checks: KClass<out ConditionalServiceChecker>)

Marks a service as being available under certain conditions.

Dependencies

@Inherited

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

annotation class Dependencies(val value: KClass<*>)

Marks a service as requiring other services.

IgnoreServiceTypes

@Inherited

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

annotation class IgnoreServiceTypes(val types: KClass<*>)

Removes the specified types a service would have been registered as.

InjectedService

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class InjectedService

No-op annotation marking a class as an injected service.

InterfacedService

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class InterfacedService(val acceptMultiple: Boolean)

Marker annotation on interfaces intended to be implemented by a service.

Lazy

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

@Lazy

annotation class Lazy

Defines a service provider as being lazy.

MissingServiceMessage

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class MissingServiceMessage(val message: String)

Defines a message to display when a service of that type has no provider.

Primary

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

@Primary

annotation class Primary

Defines a primary service provider.

Resolver

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

@Bean

@Component

@BService

annotation class Resolver(val priority: Int = 0)

Marks this class as a parameter resolver.
This is a specialization of @BService for parameter resolvers.

ResolverFactory

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

@Bean

@Component

@BService

annotation class ResolverFactory

Marks this class as a parameter resolver factory.
This is a specialization of @BService for parameter resolver factories.

ServiceName

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

annotation class ServiceName(val value: String)

Sets the name of this service.

ServicePriority

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

annotation class ServicePriority(val value: Int)

Sets the priority of this service.

ServiceType

@Inherited

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

annotation class ServiceType(val types: KClass<*>)

Adds additional types to register this service as.