Package rx
Class SingleSubscriber<T>
java.lang.Object
rx.SingleSubscriber<T>
- Type Parameters:
T
- the type of item the SingleSubscriber expects to observe
- All Implemented Interfaces:
Subscription
- Direct Known Subclasses:
OnSubscribeOnAssemblySingle.OnAssemblySingleSubscriber
,SingleDoAfterTerminate.SingleDoAfterTerminateSubscriber
,SingleOnSubscribeMap.MapSubscriber
Provides a mechanism for receiving push-based notifications.
After a SingleSubscriber calls a Single
's subscribe
method, the
Single
calls the SingleSubscriber's onSuccess(T)
and onError(java.lang.Throwable)
methods to provide
notifications. A well-behaved Single
will call a SingleSubscriber's onSuccess(T)
method exactly
once or the SingleSubscriber's onError(java.lang.Throwable)
method exactly once.
- Since:
- (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal void
add
(Subscription s) Adds aSubscription
to this Subscriber's list of subscriptions if this list is not marked as unsubscribed.final boolean
Indicates whether this Subscriber has unsubscribed from its list of subscriptions.abstract void
Notifies the SingleSubscriber that theSingle
has experienced an error condition.abstract void
Notifies the SingleSubscriber with a single item and that theSingle
has finished sending push-based notifications.final void
Stops the receipt of notifications on theSubscriber
that was registered when this Subscription was received.
-
Field Details
-
cs
-
-
Constructor Details
-
SingleSubscriber
public SingleSubscriber()
-
-
Method Details
-
onSuccess
Notifies the SingleSubscriber with a single item and that theSingle
has finished sending push-based notifications.The
Single
will not call this method if it callsonError(java.lang.Throwable)
.- Parameters:
value
- the item emitted by the Single
-
onError
Notifies the SingleSubscriber that theSingle
has experienced an error condition.If the
Single
calls this method, it will not thereafter callonSuccess(T)
.- Parameters:
error
- the exception encountered by the Single
-
add
Adds aSubscription
to this Subscriber's list of subscriptions if this list is not marked as unsubscribed. If the list is marked as unsubscribed,add
will indicate this by explicitly unsubscribing the newSubscription
as well.- Parameters:
s
- theSubscription
to add
-
unsubscribe
public final 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
-
isUnsubscribed
public final boolean isUnsubscribed()Indicates whether this Subscriber has unsubscribed from its list of subscriptions.- Specified by:
isUnsubscribed
in interfaceSubscription
- Returns:
true
if this Subscriber has unsubscribed from its subscriptions,false
otherwise
-