tegral-featureful/guru.zoroark.tegral.featureful/SimpleFeature

SimpleFeature

A simplified interface for Feature that cannot be configured.

In reality, the type of the configuration is Unit. If you need to use SimpleFeature in combination with ConfigurableFeature or other specializations of Feature, use Unit as the type parameter.

Properties

dependencies

open val dependencies: Set<Feature<*>>

Dependencies for this feature. Dependencies are features that will be installed together with (but not necessarily before) your feature.

description

abstract val description: String

A short description of what your feature provides.

abstract val id: String

The identifier for this feature. Should be a lower case kebab-case string (e.g. this-is-my-feature).

name

abstract val name: String

The name for your feature, e.g. My Feature.

Functions

createConfigObject

open override fun createConfigObject()

Create an object that will be used as the receiver parameter for install(MyFeature) { HERE }

install

abstract fun ExtensibleContextBuilderDsl.install()

Identical to Feature.install, but without a configuration object.

open override fun ExtensibleContextBuilderDsl.install(configuration: Unit)

Callback when this feature is installed onto an environment.