kodein-di/org.kodein.di.bindings/BindingDI

BindingDI

interface BindingDI<out C : Any> : DirectDI, WithContext<C>

Direct DI interface to be passed to factory methods that hold references.

It is augmented to allow such methods to access the context of the retrieval, as well as a factory from the binding it is overriding (if it is overriding).

Parameters

The type of the context

Functions

Factory

abstract fun <A, T : Any> Factory( argType: TypeToken<in A>, type: TypeToken<T>, tag: Any? = null): (A) -> T

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

FactoryOrNull

abstract fun <A, T : Any> FactoryOrNull( argType: TypeToken<in A>, type: TypeToken<T>, tag: Any? = null): (A) -> T?

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

Instance

abstract fun <T : Any> Instance(type: TypeToken<T>, tag: Any? = null): T

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

abstract fun <A, T : Any> Instance( argType: TypeToken<in A>, type: TypeToken<T>, tag: Any? = null, arg: A): T

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

InstanceOrNull

abstract fun <T : Any> InstanceOrNull(type: TypeToken<T>, tag: Any? = null): T?

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

abstract fun <A, T : Any> InstanceOrNull( argType: TypeToken<in A>, type: TypeToken<T>, tag: Any? = null, arg: A): T?

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

abstract fun On(context: DIContext<*>): DirectDI

Returns a DirectDI with its context changed.

onErasedContext

abstract fun onErasedContext(): BindingDI<C>

overriddenFactory

abstract fun overriddenFactory(): (Any?) -> Any

Gets a factory from the overridden binding.

overriddenFactoryOrNull

abstract fun overriddenFactoryOrNull(): (Any?) -> Any?

Gets a factory from the overridden binding, if this binding overrides an existing binding.

Provider

abstract fun <T : Any> Provider(type: TypeToken<T>, tag: Any? = null): () -> T

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

abstract fun <A, T : Any> Provider( argType: TypeToken<in A>, type: TypeToken<T>, tag: Any? = null, arg: () -> A): () -> T

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

ProviderOrNull

abstract fun <T : Any> ProviderOrNull(type: TypeToken<T>, tag: Any? = null): () -> T?

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

abstract fun <A, T : Any> ProviderOrNull( argType: TypeToken<in A>, type: TypeToken<T>, tag: Any? = null, arg: () -> A): () -> T?

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

Properties

container

abstract val container: DIContainer

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

context

abstract val context: C

The context that was given at retrieval.

open val di: DI

Returns a regular DI instance (DI is lazy by default).

directDI

abstract val directDI: DirectDI

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

lazy

abstract val lazy: DI

Returns a regular DI instance (DI is lazy by default).