rx.subscriptions

Class BooleanSubscription

java.lang.Object

rx.subscriptions.BooleanSubscription

All Implemented Interfaces:

Subscription

public final class BooleanSubscription
extends java.lang.Object
implements Subscription

Subscription that can be checked for status such as in a loop inside an Observable to exit the loop if unsubscribed.

See Also:

Rx.Net equivalent BooleanDisposable

Constructor Summary

Constructors

Constructor and Description
BooleanSubscription()

Method Summary

Methods

Modifier and Type	Method and Description
static BooleanSubscription	create()
static BooleanSubscription	create(Action0 onUnsubscribe)
boolean	isUnsubscribed()
void	unsubscribe() Stop receiving notifications on the Subscriber that was registered when this Subscription was received.

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanSubscription

public BooleanSubscription()

Method Detail

create

public static BooleanSubscription create()

create

public static BooleanSubscription create(Action0 onUnsubscribe)

isUnsubscribed

public boolean isUnsubscribed()

Specified by:

isUnsubscribed in interface Subscription

unsubscribe

public final void unsubscribe()

Description copied from interface: Subscription

Stop receiving notifications on the Subscriber that was registered when this Subscription was received.

This allows unregistering an Subscriber before it has finished receiving all events (ie. before onCompleted is called).

Specified by:

unsubscribe in interface Subscription