autodispose-lifecycle/autodispose2.lifecycle/TestLifecycleScopeProvider

TestLifecycleScopeProvider

class TestLifecycleScopeProvider : LifecycleScopeProvider<@NonNull E>

Test utility to create LifecycleScopeProvider instances for tests.

Supports a start and stop lifecycle. Subscribing when outside of the lifecycle will throw either a LifecycleNotStartedException or LifecycleEndedException.

Types

enum TestLifecycle

Functions

correspondingEvents

open fun correspondingEvents(): CorrespondingEventsFunction<TestLifecycleScopeProvider.TestLifecycle>

Returns a sequence of lifecycle events.

open fun create(): TestLifecycleScopeProvider

Returns a new TestLifecycleScopeProvider instance.

open fun createInitial(initialValue: TestLifecycleScopeProvider.TestLifecycle): TestLifecycleScopeProvider

Returns a new TestLifecycleScopeProvider instance with initialValue as its initial lifecycle event.

open fun lifecycle(): Observable<TestLifecycleScopeProvider.TestLifecycle>

Returns a sequence of lifecycle events.

open fun peekLifecycle(): TestLifecycleScopeProvider.TestLifecycle

Returns the last seen lifecycle event, or null if none.

open fun requestScope(): CompletableSource

open fun start()

Start the test lifecycle.

open fun stop()

Stop the test lifecycle.