io.objectbox.reactive

Class DataSubscriptionList

java.lang.Object

io.objectbox.reactive.DataSubscriptionList

All Implemented Interfaces:

DataSubscription

public class DataSubscriptionList
extends java.lang.Object
implements DataSubscription

Tracks any number of DataSubscription objects, which can be canceled with a single cancel() call. This is typically used in live cycle components like Android's Activity:

• Make DataSubscriptionList a field
• Call add(DataSubscription) during onStart/onResume for each subscription
• Call cancel() during onStop/onPause

Constructor Summary

Constructors

Constructor and Description
DataSubscriptionList()

Method Summary

Modifier and Type	Method and Description
void	add(DataSubscription subscription) Add the given subscription to the list of tracked subscriptions.
void	cancel() Cancels all tracked subscriptions and removes all references to them.
int	getActiveSubscriptionCount() Returns number of active (added) subscriptions (resets to 0 after cancel()).
boolean	isCanceled() Returns true if cancel() was called without any subsequent calls to add(DataSubscription).

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSubscriptionList

public DataSubscriptionList()

Method Detail

add

public void add(DataSubscription subscription)

Add the given subscription to the list of tracked subscriptions. Clears any previous "canceled" state.

cancel

public void cancel()

Cancels all tracked subscriptions and removes all references to them.

Specified by:

cancel in interface DataSubscription

isCanceled

public boolean isCanceled()

Returns true if cancel() was called without any subsequent calls to add(DataSubscription).

Specified by:

isCanceled in interface DataSubscription

getActiveSubscriptionCount

public int getActiveSubscriptionCount()

Returns number of active (added) subscriptions (resets to 0 after cancel()).