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

common

interface BindBuilder<C : Any>

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

Builder

common

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

common

object Companion

DependencyLoopException

common

class DependencyLoopException : RuntimeException

Exception thrown when there is a dependency loop.

DIDsl

common

@DslMarker

annotation class DIDsl

Defines a di DSL function

Key

common

data class Key<in C : Any, in A, out T : Any>(contextType: TypeToken<in C>, argType: TypeToken<in A>, type: TypeToken<out T>, 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

common

interface MainBuilder : DI.Builder

Builder to create a DI object.

Module

common

data class Module(name: String, allowSilentOverride: Boolean, prefix: String, init: DI.Builder.() -> Unit)

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

NoResultException

common

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

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

NotFoundException

common

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

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

OverridingException

common

class OverridingException(message: String) : RuntimeException

Exception thrown when there is an overriding error.

Properties

container

common

abstract val container: DIContainer

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

common

open override val di: DI

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

diContext

common

open val diContext: DIContext<*>

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

diTrigger

common

open val diTrigger: DITrigger?

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

Inheritors

LateInitDI

LazyDI