Class BooleanSubscription

java.lang.Object
rx.subscriptions.BooleanSubscription
All Implemented Interfaces:
Subscription

public final class BooleanSubscription extends 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 Details

  • Constructor Details

    • BooleanSubscription

      public BooleanSubscription()
    • BooleanSubscription

      private BooleanSubscription(Action0 action)
  • Method Details

    • 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