rxjava 1.3.8 · rx.SingleSubscriber

Provides a mechanism for receiving push-based notifications.

After a SingleSubscriber calls a Single's subscribe method, the Single calls the SingleSubscriber's onSuccess and onError methods to provide notifications. A well-behaved Single will call a SingleSubscriber's onSuccess method exactly once or the SingleSubscriber's onError method exactly once.

Note, that if you want isUnsubscribed to return true after onSuccess or onError invocation, you need to invoke unsubscribe in these methods.

Modifier and Type	Field and Description
private final SubscriptionList	cs

Constructor Summary

Access	Constructor and Description
public	SingleSubscriber()

Method Summary

Modifier and Type	Method and Description
public final void	add(Subscription the `Subscription` to add s) Adds a `Subscription` to this Subscriber's list of subscriptions if this list is not marked as unsubscribed.
public final boolean	Returns: `true` if this Subscriber has unsubscribed from its subscriptions, `false` otherwise isUnsubscribed() Implements rx.Subscription.isUnsubscribed. Indicates whether this Subscriber has unsubscribed from its list of subscriptions.
public abstract void	onError(Throwable the exception encountered by the Single error) Notifies the SingleSubscriber that the `Single` has experienced an error condition.
public abstract void	onSuccess(T the item emitted by the Single t) Notifies the SingleSubscriber with a single item and that the `Single` has finished sending push-based notifications.
public final void	unsubscribe() Implements rx.Subscription.unsubscribe. Stops the receipt of notifications on the `Subscriber` that was registered when this Subscription was received.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cs	back to summary
private final SubscriptionList cs

Constructor Detail

SingleSubscriber	back to summary
public SingleSubscriber()

Method Detail

add back to summary

add	back to summary
public final void add(Subscription s) Adds a `Subscription` 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 new `Subscription` as well. Parameters s:Subscription the `Subscription` to add

public final void add(Subscription s)

Adds a Subscription 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 new Subscription as well.

Parameters

s:Subscription: the Subscription to add

isUnsubscribed back to summary

isUnsubscribed	back to summary
public final boolean isUnsubscribed() Implements rx.Subscription.isUnsubscribed. Indicates whether this Subscriber has unsubscribed from its list of subscriptions. Returns:boolean `true` if this Subscriber has unsubscribed from its subscriptions, `false` otherwise Annotations @Override

public final boolean isUnsubscribed()

Implements rx.Subscription.isUnsubscribed.

Indicates whether this Subscriber has unsubscribed from its list of subscriptions.

Returns:boolean

true if this Subscriber has unsubscribed from its subscriptions, false otherwise

Annotations

@Override

onError back to summary

onError	back to summary
public abstract void onError(Throwable error) Notifies the SingleSubscriber that the `Single` has experienced an error condition. If the `Single` calls this method, it will not thereafter call `onSuccess`. Parameters error:Throwable the exception encountered by the Single

public abstract void onError(Throwable error)

Notifies the SingleSubscriber that the Single has experienced an error condition.

If the Single calls this method, it will not thereafter call onSuccess.

Parameters

error:Throwable: the exception encountered by the Single

onSuccess back to summary

onSuccess	back to summary
public abstract void onSuccess(T t) Notifies the SingleSubscriber with a single item and that the `Single` has finished sending push-based notifications. The `Single` will not call this method if it calls `onError`. Parameters t:T the item emitted by the Single

public abstract void onSuccess(T t)

Notifies the SingleSubscriber with a single item and that the Single has finished sending push-based notifications.

The Single will not call this method if it calls onError.

Parameters

t:T: the item emitted by the Single

unsubscribe back to summary

unsubscribe	back to summary
public final void unsubscribe() Implements rx.Subscription.unsubscribe. Doc from rx.Subscription.unsubscribe. Stops the receipt of notifications on the `Subscriber` that was registered when this Subscription was received. This allows deregistering an `Subscriber` before it has finished receiving all events (i.e. before onCompleted is called). Annotations @Override

public final void unsubscribe()

Implements rx.Subscription.unsubscribe.

Doc from rx.Subscription.unsubscribe.

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

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

Annotations

@Override

public abstract Class SingleSubscriber<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail