Winter/io.jentz.winter/Winter

Winter

object Winter : WinterApplication(source)

The default WinterApplication object.

It is recommended for applications to use this directly and for libraries it is recommended to create a library specific object based on WinterApplication.

Example:

// configure application component
Winter.component {
  // ... dependency declaration
}
// install a Winter plugin
Winter.installMyPlugin()
// open the application dependency graph
Winter.openGraph()

See also

WinterApplication

for more details.

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