com.uber.autodispose.lifecycle

Class TestLifecycleScopeProvider

java.lang.Object

com.uber.autodispose.lifecycle.TestLifecycleScopeProvider

All Implemented Interfaces:

LifecycleScopeProvider<TestLifecycleScopeProvider.TestLifecycle>

public final class TestLifecycleScopeProvider
extends java.lang.Object
implements LifecycleScopeProvider<TestLifecycleScopeProvider.TestLifecycle>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestLifecycleScopeProvider.TestLifecycle

Method Summary

Modifier and Type	Method and Description
CorrespondingEventsFunction<TestLifecycleScopeProvider.TestLifecycle>	correspondingEvents()
static TestLifecycleScopeProvider	create()
static TestLifecycleScopeProvider	createInitial(TestLifecycleScopeProvider.TestLifecycle initialValue)
<any>	lifecycle()
TestLifecycleScopeProvider.TestLifecycle	peekLifecycle()
CompletableSource	requestScope()
void	start() Start the test lifecycle.
void	stop() Stop the test lifecycle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static TestLifecycleScopeProvider create()

Returns:

a new TestLifecycleScopeProvider instance.

createInitial

public static TestLifecycleScopeProvider createInitial(TestLifecycleScopeProvider.TestLifecycle initialValue)

Parameters:

initialValue - the initial lifecycle event to create the TestLifecycleScopeProvider with.

Returns:

a new TestLifecycleScopeProvider instance with as its initial lifecycle event.

lifecycle

public <any> lifecycle()

Specified by:

lifecycle in interface LifecycleScopeProvider<TestLifecycleScopeProvider.TestLifecycle>

Returns:

a sequence of lifecycle events. Note that completion of this lifecycle will also trigger disposal

correspondingEvents

public CorrespondingEventsFunction<TestLifecycleScopeProvider.TestLifecycle> correspondingEvents()

Specified by:

correspondingEvents in interface LifecycleScopeProvider<TestLifecycleScopeProvider.TestLifecycle>

Returns:

a sequence of lifecycle events. It's recommended to back this with a static instance to avoid unnecessary object allocation.

peekLifecycle

public TestLifecycleScopeProvider.TestLifecycle peekLifecycle()

Specified by:

peekLifecycle in interface LifecycleScopeProvider<TestLifecycleScopeProvider.TestLifecycle>

Returns:

the last seen lifecycle event, or null if none. Note that is null is returned at subscribe-time, it will be used as a signal to throw a LifecycleNotStartedException.

requestScope

public CompletableSource requestScope()

start

public void start()

Start the test lifecycle.

stop

public void stop()

Stop the test lifecycle.