DI

KOtlin DEpendency INjection.

To construct a DI instance, simply use it's block constructor and define your bindings in it :

val di = DI {
    bind<Dice>() with factory { sides: Int -> RandomDice(sides) }
    bind<DataSource>() with singleton { SqliteDS.open("path/to/file") }
    bind<Random>() with provider { SecureRandom() }
    constant("answer") with "forty-two"
}

Types

BindBuilder

interface BindBuilder<C : Any>

Base builder DSL interface that allows to define scoped and context bindings.

Builder

interface Builder : DI.BindBuilder<Any> , DI.BindBuilder.WithScope<Any>

Allows for the DSL inside the block argument of the constructor of DI and DI.Module.

Companion

object Companion

DependencyLoopException

class DependencyLoopException : RuntimeException

Exception thrown when there is a dependency loop.

DIDsl

@DslMarker

annotation class DIDsl

Defines a di DSL function

Key

data class Key<in C : Any, in A, out T : Any>(val contextType: TypeToken<in C>, val argType: TypeToken<in A>, val type: TypeToken<out T>, val tag: Any?)

In DI, each DIBinding is bound to a Key. A Key holds all information necessary to retrieve a factory (and therefore an instance).

MainBuilder

interface MainBuilder : DI.Builder

Builder to create a DI object.

Module

data class Module(val allowSilentOverride: Boolean = false, val prefix: String = "", val init: DI.Builder.() -> Unit)

A module is constructed the same way as in DI is:

NoResultException

class NoResultException(val search: SearchSpecs, message: String) : RuntimeException

Exception thrown when searching for bindings and none could be found.

NotFoundException

class NotFoundException(val key: DI.Key<*, *, *>, message: String) : RuntimeException

Exception thrown when asked for a dependency that cannot be found.

OverridingException

class OverridingException(message: String) : RuntimeException

Exception thrown when there is an overriding error.

Properties

container

abstract val container: DIContainer

Every methods eventually ends up to a call to this container.

open override val di: DI

A DI Aware class must be within reach of a DI object.

diContext

open val diContext: DIContext<*>

A DI Aware class can define a context that is for all retrieval by overriding this property.

diTrigger

open val diTrigger: DITrigger?

Trigger to use that define when the retrieval will be done.

Inheritors

LateInitDI

LazyDI

Extensions

AllFactories

inline fun <A : Any, T : Any> DIAware.allFactories(tag: Any? = null): LazyDelegate<List<(A) -> T>>

Gets all factories that match the the given argument type, return type and tag.

AllInstances

inline fun <T : Any> DIAware.allInstances(tag: Any? = null): LazyDelegate<List<T>>

Gets all instances from providers that match the the given return type and tag.

inline fun <A : Any, T : Any> DIAware.allInstances(tag: Any? = null, arg: A): LazyDelegate<List<T>>

inline fun <A, T : Any> DIAware.allInstances(tag: Any? = null, arg: Typed<A>): LazyDelegate<List<T>>

inline fun <A : Any, T : Any> DIAware.allInstances(tag: Any? = null, noinline fArg: () -> A): LazyDelegate<List<T>>

Gets all instances from providers that match the the given return type and tag, curried from factories that take an argument A.

AllProviders

inline fun <T : Any> DIAware.allProviders(tag: Any? = null): LazyDelegate<List<() -> T>>

Gets all providers that match the the given return type and tag.

inline fun <A : Any, T : Any> DIAware.allProviders(tag: Any? = null, arg: A): LazyDelegate<List<() -> T>>

inline fun <A, T : Any> DIAware.allProviders(tag: Any? = null, arg: Typed<A>): LazyDelegate<List<() -> T>>

inline fun <A : Any, T : Any> DIAware.allProviders(tag: Any? = null, noinline fArg: () -> A): LazyDelegate<List<() -> T>>

Gets all providers that match the the given return type and tag, curried from factories that take an argument A.

Constant

inline fun <T : Any> DIAware.constant(): LazyDelegate<T>

Gets a constant of type T and tag whose tag is the name of the receiving property.

direct

val DIAware.direct: DirectDI

Return a direct DirectDI instance, with its receiver and context set to this DIAware receiver and context.

Factory

inline fun <A : Any, T : Any> DIAware.factory(tag: Any? = null): LazyDelegate<(A) -> T>

Gets a factory of T for the given argument type, return type and tag.

FactoryOrNull

inline fun <A : Any, T : Any> DIAware.factoryOrNull(tag: Any? = null): LazyDelegate<(A) -> T?>

Gets a factory of T for the given argument type, return type and tag, or nul if none is found.

hasFactory

inline fun <A : Any, T : Any> DI.hasFactory(tag: Any? = null): Boolean

Define whether a factory binding exists in the given DI container

hasProvider

inline fun <T : Any> DI.hasProvider(tag: Any? = null): Boolean

Define whether a provider binding exists in the given DI container

Instance

inline fun <T : Any> DIAware.instance(tag: Any? = null): LazyDelegate<T>

Gets an instance of T for the given type and tag.

inline fun <A : Any, T : Any> DIAware.instance(tag: Any? = null, arg: A): LazyDelegate<T>

inline fun <A, T : Any> DIAware.instance(tag: Any? = null, arg: Typed<A>): LazyDelegate<T>

inline fun <A : Any, T : Any> DIAware.instance(tag: Any? = null, noinline fArg: () -> A): LazyDelegate<T>

Gets an instance of T for the given type and tag, curried from a factory that takes an argument A.

InstanceOrNull

inline fun <T : Any> DIAware.instanceOrNull(tag: Any? = null): LazyDelegate<T?>

Gets an instance of T for the given type and tag, or null if none is found.

inline fun <A : Any, T : Any> DIAware.instanceOrNull(tag: Any? = null, arg: A): LazyDelegate<T?>

inline fun <A, T : Any> DIAware.instanceOrNull(tag: Any? = null, arg: Typed<A>): LazyDelegate<T?>

inline fun <A : Any, T : Any> DIAware.instanceOrNull(tag: Any? = null, noinline fArg: () -> A): LazyDelegate<T?>

Gets an instance of T for the given type and tag, curried from a factory that takes an argument A, or null if none is found.

named

val DIAware.named: Named

Allows to get factories / providers / instances with a tag set to the name of the receiving property.

newInstance

fun <T> DIAware.newInstance(creator: DirectDI.() -> T): LazyDelegate<T>

Allows to create a new instance of an unbound object with the same API as when bounding one.

inline fun <C : Any> DIAware.on(context: C, trigger: DITrigger? = this.diTrigger): DI

inline fun <C : Any> DIAware.on(trigger: DITrigger? = this.diTrigger, crossinline getContext: () -> C): DI

Allows to create a new DI object with a context and/or a trigger set.

fun DIAware.on(trigger: DITrigger?): DI

Allows to create a new DI object with a trigger set.

Provider

inline fun <T : Any> DIAware.provider(tag: Any? = null): LazyDelegate<() -> T>

Gets a provider of T for the given type and tag.

inline fun <A : Any, T : Any> DIAware.provider(tag: Any? = null, arg: A): LazyDelegate<() -> T>

inline fun <A, T : Any> DIAware.provider(tag: Any? = null, arg: Typed<A>): LazyDelegate<() -> T>

inline fun <A : Any, T : Any> DIAware.provider(tag: Any? = null, noinline fArg: () -> A): LazyDelegate<() -> T>

Gets a provider of T for the given type and tag, curried from a factory that takes an argument A.

ProviderOrNull

inline fun <T : Any> DIAware.providerOrNull(tag: Any? = null): LazyDelegate<() -> T?>

Gets a provider of T for the given type and tag, or null if none is found.

inline fun <A : Any, T : Any> DIAware.providerOrNull(tag: Any? = null, arg: A): LazyDelegate<() -> T?>

inline fun <A, T : Any> DIAware.providerOrNull(tag: Any? = null, arg: Typed<A>): LazyDelegate<() -> T?>

inline fun <A : Any, T : Any> DIAware.providerOrNull(tag: Any? = null, noinline fArg: () -> A): LazyDelegate<() -> T?>

Gets a provider of T for the given type and tag, curried from a factory that takes an argument A, or null if none is found.