Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.util.concurrent.atomic.AtomicReference<Action0>	actionRef
(package private) static Action0	EMPTY_ACTION

Constructor Summary

Constructors

Modifier	Constructor	Description
	BooleanSubscription()
private	BooleanSubscription(Action0 action)

Method Summary

Modifier and Type	Method	Description
static BooleanSubscription	create()	Creates a BooleanSubscription without unsubscribe behavior.
static BooleanSubscription	create(Action0 onUnsubscribe)	Creates a BooleanSubscription with a specified function to invoke upon unsubscribe.
boolean	isUnsubscribed()	Indicates whether this Subscription is currently unsubscribed.
void	unsubscribe()	Stops the receipt of 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

Field Detail

actionRef

final java.util.concurrent.atomic.AtomicReference<Action0> actionRef

EMPTY_ACTION

static final Action0 EMPTY_ACTION

Constructor Detail

BooleanSubscription

public BooleanSubscription()

BooleanSubscription

private BooleanSubscription(Action0 action)

Method Detail

create

public static BooleanSubscription create()

Creates a BooleanSubscription without unsubscribe behavior.

Returns:

the created BooleanSubscription

create

public static BooleanSubscription create(Action0 onUnsubscribe)

Creates a BooleanSubscription with a specified function to invoke upon unsubscribe.

Parameters:

onUnsubscribe - an Action0 to invoke upon unsubscribe

Returns:

the created BooleanSubscription

isUnsubscribed

public boolean isUnsubscribed()

Description copied from interface: Subscription

Indicates whether this Subscription is currently unsubscribed.

Specified by:

isUnsubscribed in interface Subscription

Returns:

true if this Subscription is currently unsubscribed, false otherwise

unsubscribe

public void unsubscribe()

Description copied from interface: Subscription

Stops the receipt of notifications on the Subscriber that was registered when this Subscription was received.

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

Specified by:

unsubscribe in interface Subscription