Winter/io.jentz.winter

Package-level declarations

Types

class ClassTypeKey<R>(val type: Class<R>, val isOptional: Boolean = false, val qualifier: Qualifier? = null) : TypeKey<R>

Component

class Component

The Component stores the dependency providers which are than retrieved and instantiated by an instance of a graph.

ComponentBuilderBlock

typealias ComponentBuilderBlock = Component.Builder.() -> Unit

Function signature alias for component builder DSL blocks.

CyclicDependencyException

class CyclicDependencyException(val key: TypeKey<*>, message: String, cause: Throwable? = null) : WinterException

Exception that is thrown when a cyclic dependency was detected.

DependencyResolutionException

class DependencyResolutionException(val key: TypeKey<*>, message: String, cause: Throwable? = null) : WinterException

Exception that is thrown when an error occurs during dependency resolution.

EntryNotFoundException

class EntryNotFoundException(val key: TypeKey<*>, message: String? = null) : WinterException

Exception that is thrown when a service was not found but was requested as non-optional.

GCallback

typealias GCallback<R> = Graph.(R) -> Unit

Callback function signature with Graph as receiver.

GDisposableSideEffect

typealias GDisposableSideEffect<R> = Graph.(R) -> GCallback<R>?

GenericClassTypeKey

abstract class GenericClassTypeKey<R>(val isOptional: Boolean = false, val qualifier: Qualifier? = null) : TypeKey<R>

GFactory

typealias GFactory<R> = Graph.() -> R

Factory function signature with Graph as receiver.

Graph

class Graph

The object graph class that retrieves and instantiates dependencies registered in its component.

Provider

typealias Provider<R> = () -> R

Provider function signature.

Qualifier

@JvmInline

value class Qualifier

TypeKey

interface TypeKey<out R>

Interface for all type keys.

Winter

object Winter : WinterApplication

The default WinterApplication object.

WinterApplication

open class WinterApplication

Holds the plugins, the application Component and the application Graph.

WinterException

open class WinterException(message: String?, cause: Throwable? = null) : Exception

Base exception class of all exception thrown by Winter.

Properties

ApplicationScope

val ApplicationScope: Qualifier

Prototype

val Prototype: Qualifier

qualifier

val <E : Enum<E>> Enum<E>.qualifier: Qualifier

Singleton

val Singleton: Qualifier

Functions

component

fun component(qualifier: Qualifier = ApplicationScope, block: ComponentBuilderBlock): Component

Create an instance of Component.

emptyComponent

fun emptyComponent(): Component

Returns a Component without qualifier and without any declared dependencies.

emptyGraph

fun emptyGraph(): Graph

Returns a Graph with empty component.

erased

inline fun <R> erased(qualifier: Qualifier? = null): TypeKey<R>

Returns TypeKey for type R with erased generics.

generic

inline fun <R> generic(qualifier: Qualifier? = null): TypeKey<R>

Returns TypeKey for type R with generics information preserved.

graph

fun graph(qualifier: Qualifier = ApplicationScope, block: ComponentBuilderBlock): Graph

Create an ad-hoc instance of Graph.

ofType

inline fun <R> Set<TypeKey<*>>.ofType(key: TypeKey<R> = erased()): Set<TypeKey<R>>

qualifier

inline fun <T : Any> qualifier(): Qualifier

fun <E : Enum<E>> qualifier(value: E): Qualifier

fun qualifier(value: String): Qualifier

qualifier

fun <T : Any> KClass<T>.qualifier(): Qualifier

typeKey

inline fun <T : Any> KClass<T>.typeKey(qualifier: Qualifier? = null): ClassTypeKey<T>