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 anObservable
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BooleanSubscription
create()
Creates aBooleanSubscription
without unsubscribe behavior.static BooleanSubscription
create(Action0 onUnsubscribe)
Creates aBooleanSubscription
with a specified function to invoke upon unsubscribe.boolean
isUnsubscribed()
Indicates whether thisSubscription
is currently unsubscribed.void
unsubscribe()
Stops the receipt of notifications on theSubscriber
that was registered when this Subscription was received.
-
-
-
Constructor Detail
-
BooleanSubscription
public BooleanSubscription()
-
BooleanSubscription
private BooleanSubscription(Action0 action)
-
-
Method Detail
-
create
public static BooleanSubscription create()
Creates aBooleanSubscription
without unsubscribe behavior.- Returns:
- the created
BooleanSubscription
-
create
public static BooleanSubscription create(Action0 onUnsubscribe)
Creates aBooleanSubscription
with a specified function to invoke upon unsubscribe.- Parameters:
onUnsubscribe
- anAction0
to invoke upon unsubscribe- Returns:
- the created
BooleanSubscription
-
isUnsubscribed
public boolean isUnsubscribed()
Description copied from interface:Subscription
Indicates whether thisSubscription
is currently unsubscribed.- Specified by:
isUnsubscribed
in interfaceSubscription
- Returns:
true
if thisSubscription
is currently unsubscribed,false
otherwise
-
unsubscribe
public void unsubscribe()
Description copied from interface:Subscription
Stops the receipt of notifications on theSubscriber
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 interfaceSubscription
-
-