tegral-web-appdsl/guru.zoroark.tegral.web.appdsl

Package-level declarations

Types

ContextInstallationHook

typealias ContextInstallationHook = ExtensibleContextBuilderDsl.() -> Unit

FeatureBuilder

class FeatureBuilder<T>(val feature: Feature<T>, val configBuilder: T.(FeatureContext) -> Unit)

Class that stores necessary data for building a Feature.

FeatureContext

class FeatureContext(val configuration: RootConfig)

The context within which a feature gets installed.

TegralApplication

class TegralApplication(val environment: ExtensibleInjectionEnvironment)

This object represents a built and possibly running Tegral application.

TegralApplicationBuilder

class TegralApplicationBuilder : TegralApplicationDsl, Buildable<TegralApplication>

Builder for a Tegral application. This class allows you to install features, tweak the application's configuration, add modules, classes and components of your own, etc. This is the class that is used as a receiver within the tegral block.

TegralApplicationDsl

interface TegralApplicationDsl : ExtensibleContextBuilderDsl

DSL interface for configurating Tegral applications.

TegralApplicationFeatureBuilder

class TegralApplicationFeatureBuilder : ExtensibleContextBuilderDsl, Buildable<FeatureBuilder<Unit>>

Builder for a TegralCustomFeature specifically tailored to contain the logic from the tegral block.

TegralCustomFeature

class TegralCustomFeature(val id: String, val name: String, val description: String, installationCallback: ContextInstallationHook) : SimpleFeature

This class allows for the dynamic creation of ad-hoc features.

Properties

features

val TegralApplication.features: Sequence<Feature<*>>

Returns all the features that were installed in this application.

lifecycleFeatures

val TegralApplication.lifecycleFeatures: Sequence<LifecycleHookedFeature<*>>

Returns all the features that additionally implement LifecycleHookedFeature that were installed in this application.

Functions

applyDefaults

fun TegralApplicationDsl.applyDefaults()

Applies sane defaults to the given application builder. Specifically, this function:

install

fun <T> TegralApplicationDsl.install(feature: Feature<T>)

Install the feature onto this application.

fun <T> TegralApplicationDsl.install(feature: Feature<T>, configBlock: T.(FeatureContext) -> Unit)

Install the feature onto this application, additionally configuring it with the provided lambda.

tegral

fun tegral(enableLoggingOverrides: Boolean = true, enableDefaults: Boolean = true, block: TegralApplicationDsl.() -> Unit): TegralApplication

Starting block for creating, configuring and launching a Tegral application. This function:

useConfigurationType

inline fun <T : RootConfig> TegralApplicationDsl.useConfigurationType(noinline configuration: ConfigLoaderBuilder.() -> Unit = {})

Equivalent to TegralApplicationDsl.useConfigurationClass, but uses a reified type instead.