spring-beans/org.springframework.beans.factory/BeanRegistrarDsl

BeanRegistrarDsl

open class BeanRegistrarDsl(init: BeanRegistrarDsl.() -> Unit) : BeanRegistrar

Contract for registering programmatically beans.

Typically imported with an @Import annotation on @Configuration classes.

@Configuration
@Import(MyBeanRegistrar::class)
class MyConfiguration {
}
Content copied to clipboard

In Kotlin, a bean registrar is typically created with a BeanRegistrarDsl to register beans programmatically in a concise and flexible way.

class MyBeanRegistrar : BeanRegistrarDsl({
	   registerBean<Foo>()
	   registerBean(
        name = "bar",
        prototype = true,
        lazyInit = true,
        description = "Custom description") {
            Bar(bean<Foo>())
    }
    profile("baz") {
        registerBean { Baz("Hello World!") }
    }
})
Content copied to clipboard

Author

Sebastien Deleuze

Since

7.0

Constructors

Link copied to clipboard
constructor(init: BeanRegistrarDsl.() -> Unit)

Types

Link copied to clipboard
open class SupplierContextDsl<T>(context: BeanRegistry.SupplierContext, val env: Environment)

Context available from the bean instance supplier designed to give access to bean dependencies.

Properties

Link copied to clipboard
lateinit var env: Environment

The environment that can be used to get the active profile or some properties.

Functions

Link copied to clipboard
fun profile(expression: String, init: BeanRegistrarDsl.() -> Unit)

Apply the nested block if the given profile expression matches the active profiles.

Link copied to clipboard
fun register(registrar: BeanRegistrar)

Register beans using the given BeanRegistrar.

open override fun register(registry: BeanRegistry, env: Environment)
Link copied to clipboard
fun registerAlias(name: String, alias: String)

Given a name, register an alias for it.

Link copied to clipboard
inline fun <T : Any> registerBean(autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any> registerBean(name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)

Register a bean of type T which will be instantiated using the related resolvable constructor if any.

inline fun <T : Any> registerBean(autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false, crossinline supplier: BeanRegistrarDsl.SupplierContextDsl<T>.() -> T): String

inline fun <T : Any> registerBean(crossinline f: () -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any> registerBean(crossinline f: () -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)

Register a bean of type T which will be instantiated by invoking the provided function.

inline fun <T : Any, A : Any> registerBean(crossinline f: (A) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any, B : Any> registerBean(crossinline f: (A, B) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any, B : Any, C : Any> registerBean(crossinline f: (A, B, C) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any> registerBean(crossinline f: (A, B, C, D) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any> registerBean(crossinline f: (A, B, C, D, E) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any, F : Any> registerBean(crossinline f: (A, B, C, D, E, F) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any, F : Any, G : Any> registerBean(crossinline f: (A, B, C, D, E, F, G) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any, F : Any, G : Any, H : Any> registerBean(crossinline f: (A, B, C, D, E, F, G, H) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any, F : Any, G : Any, H : Any, I : Any> registerBean(crossinline f: (A, B, C, D, E, F, G, H, I) -> T, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false): String
inline fun <T : Any, A : Any> registerBean(crossinline f: (A) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)
inline fun <T : Any, A : Any, B : Any> registerBean(crossinline f: (A, B) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)
inline fun <T : Any, A : Any, B : Any, C : Any> registerBean(crossinline f: (A, B, C) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any> registerBean(crossinline f: (A, B, C, D) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any> registerBean(crossinline f: (A, B, C, D, E) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any, F : Any> registerBean(crossinline f: (A, B, C, D, E, F) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any, F : Any, G : Any> registerBean(crossinline f: (A, B, C, D, E, F, G) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any, F : Any, G : Any, H : Any> registerBean(crossinline f: (A, B, C, D, E, F, G, H) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)
inline fun <T : Any, A : Any, B : Any, C : Any, D : Any, E : Any, F : Any, G : Any, H : Any, I : Any> registerBean(crossinline f: (A, B, C, D, E, F, G, H, I) -> T, name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false)

Register a bean of type T which will be instantiated by invoking the provided function with its parameters autowired by type.

inline fun <T : Any> registerBean(name: String, autowirable: Boolean = true, backgroundInit: Boolean = false, description: String? = null, fallback: Boolean = false, infrastructure: Boolean = false, lazyInit: Boolean = false, order: Int? = null, primary: Boolean = false, prototype: Boolean = false, crossinline supplier: BeanRegistrarDsl.SupplierContextDsl<T>.() -> T)

Register a bean of type T which will be instantiated using the provided supplier.