com.uber.autodispose.android.lifecycle

Class AndroidLifecycleScopeProvider

java.lang.Object

com.uber.autodispose.android.lifecycle.AndroidLifecycleScopeProvider

public final class AndroidLifecycleScopeProvider
extends java.lang.Object

A LifecycleScopeProvider that can provide scoping for Android Lifecycle and LifecycleOwner classes.

   AutoDispose.autoDisposable(AndroidLifecycleScopeProvider.from(lifecycleOwner))
 

Method Summary

Modifier and Type	Method and Description
<any>	correspondingEvents()
static AndroidLifecycleScopeProvider	from(Lifecycle lifecycle) Creates a AndroidLifecycleScopeProvider for Android Lifecycles.
static AndroidLifecycleScopeProvider	from(Lifecycle lifecycle, <any> boundaryResolver) Creates a AndroidLifecycleScopeProvider for Android Lifecycles.
static AndroidLifecycleScopeProvider	from(Lifecycle lifecycle, Lifecycle.Event untilEvent) Creates a AndroidLifecycleScopeProvider for Android Lifecycles.
static AndroidLifecycleScopeProvider	from(LifecycleOwner owner) Creates a AndroidLifecycleScopeProvider for Android LifecycleOwners.
static AndroidLifecycleScopeProvider	from(LifecycleOwner owner, <any> boundaryResolver) Creates a AndroidLifecycleScopeProvider for Android Lifecycles.
static AndroidLifecycleScopeProvider	from(LifecycleOwner owner, Lifecycle.Event untilEvent) Creates a AndroidLifecycleScopeProvider for Android LifecycleOwners.
<any>	lifecycle()
Lifecycle.Event	peekLifecycle()
CompletableSource	requestScope()

Methods inherited from class java.lang.Object

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

Method Detail

from

public static AndroidLifecycleScopeProvider from(LifecycleOwner owner)

Creates a AndroidLifecycleScopeProvider for Android LifecycleOwners.

Parameters:

owner - the owner to scope for.

Returns:

a AndroidLifecycleScopeProvider against this owner.

from

public static AndroidLifecycleScopeProvider from(LifecycleOwner owner,
                                                 Lifecycle.Event untilEvent)

Creates a AndroidLifecycleScopeProvider for Android LifecycleOwners.

Parameters:

owner - the owner to scope for.

untilEvent - the event until the scope is valid.

Returns:

a AndroidLifecycleScopeProvider against this owner.

from

public static AndroidLifecycleScopeProvider from(Lifecycle lifecycle)

Creates a AndroidLifecycleScopeProvider for Android Lifecycles.

Parameters:

lifecycle - the lifecycle to scope for.

Returns:

a AndroidLifecycleScopeProvider against this lifecycle.

from

public static AndroidLifecycleScopeProvider from(Lifecycle lifecycle,
                                                 Lifecycle.Event untilEvent)

Creates a AndroidLifecycleScopeProvider for Android Lifecycles.

Parameters:

lifecycle - the lifecycle to scope for.

untilEvent - the event until the scope is valid.

Returns:

a AndroidLifecycleScopeProvider against this lifecycle.

from

public static AndroidLifecycleScopeProvider from(LifecycleOwner owner,
                                                 <any> boundaryResolver)

Creates a AndroidLifecycleScopeProvider for Android Lifecycles.

Parameters:

owner - the owner to scope for.

boundaryResolver - function that resolves the event boundary.

Returns:

a AndroidLifecycleScopeProvider against this owner.

from

public static AndroidLifecycleScopeProvider from(Lifecycle lifecycle,
                                                 <any> boundaryResolver)

Creates a AndroidLifecycleScopeProvider for Android Lifecycles.

Parameters:

lifecycle - the lifecycle to scope for.

boundaryResolver - function that resolves the event boundary.

Returns:

a AndroidLifecycleScopeProvider against this lifecycle.

lifecycle

public <any> lifecycle()

correspondingEvents

public <any> correspondingEvents()

peekLifecycle

public Lifecycle.Event peekLifecycle()

requestScope

public CompletableSource requestScope()