spring-boot/org.springframework.boot.context.properties/ConfigurationPropertiesScan

ConfigurationPropertiesScan

@Target(value = ElementType.TYPE)

@Retention(value = RetentionPolicy.RUNTIME)

@Import(value = ConfigurationPropertiesScanRegistrar::class)

@EnableConfigurationProperties

annotation class ConfigurationPropertiesScan

Configures the base packages used when scanning for @ConfigurationProperties classes. One of basePackageClasses, basePackages or its alias value may be specified to define specific packages to scan. If specific packages are not defined scanning will occur from the package of the class with this annotation.

Note: Classes annotated or meta-annotated with @Component will not be picked up by this annotation.

Author

Madhura Bhave

Since

2.2.0

Functions

abstract fun annotationType(): Class<out Annotation>

basePackageClasses

abstract fun basePackageClasses(): Array<Class<out Any>>

Type-safe alternative to basePackages for specifying the packages to scan for configuration properties.

@AliasFor(value = "value")

abstract fun basePackages(): Array<String>

Base packages to scan for configuration properties.

abstract fun equals(p: Any): Boolean

abstract fun hashCode(): Int

abstract fun toString(): String

@AliasFor(value = "basePackages")

abstract fun value(): Array<String>

Alias for the basePackages attribute.