simple-scaffold/dev.keyboardr.mapsl.simple.scaffold

Package-level declarations

Types

MainServiceLocator

object MainServiceLocator

Holds the pre-configured, application-wide SimpleServiceLocator instance.

@VisibleForTesting

interface MockFactory

An interface for integrating a mocking library with the TestServiceLocator.

ServiceLocatorInitializer

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

class ServiceLocatorInitializer : Initializer<SimpleServiceLocator<ServiceLocatorScope>>

An Initializer that automatically registers a production MainServiceLocator on app startup using the androidx.startup library.

ServiceLocatorScope

enum ServiceLocatorScope : Enum<ServiceLocatorScope>

Defines the environments for the simple-scaffold.

TestServiceLocator

@VisibleForTesting

object TestServiceLocator

An object for setting up the test environment when using the simple-scaffold.

Functions

inline fun <T : Any> SimpleServiceLocator<ServiceLocatorScope>.getOrProvide(threadSafetyMode: LazyThreadSafetyMode = defaultThreadSafetyMode, noinline provider: (ServiceLocatorScope) -> T): T

Fetches the singleton instance for the reified type T.

inline fun <T : Any> serviceLocator(noinline allowedScopes: (ServiceLocatorScope) -> Boolean = { it == ServiceLocatorScope.Production }, threadSafetyMode: LazyThreadSafetyMode = MainServiceLocator.instance.defaultThreadSafetyMode, noinline provider: (ServiceLocatorScope) -> T): ReadOnlyProperty<Any, T>

Creates a property delegate for lazily retrieving a service from the MainServiceLocator.