Winter/io.jentz.winter/WinterApplication

WinterApplication

open class WinterApplication(source)

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

Applications usually use the Winter object. To use Winter in a library it is recommended to create a library specific object from WinterApplication, so that the library doesn't share its component, graph and plugins with the application.

Example:

// configure the application component
Winter.component {
  singleton<GitHubApi> { GitHubApiImpl() }
  singleton { RepoListViewModel(instance()) }
}
// open the application graph
val graph = Winter.openGraph()

Classes that can't use constructor injection (e.g. Android activities) can retrieve their dependencies from the application graph with the property delegates of the winter-delegate module.

Inheritors

Constructors

WinterApplication

constructor()

constructor(qualifier: Qualifier = ApplicationScope, block: ComponentBuilderBlock)

Convenient constructor to configure the application Component during initialization.

Properties

var component: Component

The application component.

val graph: Graph

Get the application graph.

var graphOrNull: Graph?

Get the application graph if open otherwise null.

var plugins: Plugins

The plugins registered on the application.

Functions

fun closeGraph()

Close the application graph.

closeGraphIfOpen

fun closeGraphIfOpen()

Close the application graph if open otherwise do nothing.

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

Sets the application component by supplying an optional qualifier and a component builder block.

fun createGraph(block: ComponentBuilderBlock? = null): Graph

Create graph from component without registering it as application graph.

fun getOrOpenGraph(block: ComponentBuilderBlock? = null): Graph

Get application graph if already open otherwise open and return it.

fun openGraph(block: ComponentBuilderBlock? = null): Graph

Open the application component.

fun WinterApplication.plugin(builder: PluginBuilderBlock): () -> Unit