rx.subscriptions

Class CompositeSubscription

  • All Implemented Interfaces:
    Subscription 

    public final class CompositeSubscription
extends Object
implements Subscription
    Subscription that represents a group of Subscriptions that are unsubscribed together.

    • Constructor Detail

      • CompositeSubscription

        public CompositeSubscription()

      • CompositeSubscription

        public CompositeSubscription(Subscription... subscriptions)

    • Method Detail

      • 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

      • add

        public void add(Subscription s)
        Adds a new Subscription to this CompositeSubscription if the CompositeSubscription is not yet unsubscribed. If the CompositeSubscription is unsubscribed, add will indicate this by explicitly unsubscribing the new Subscription as well.
        Parameters:
        s - the Subscription to add

      • clear

        public void clear()
        Unsubscribes any subscriptions that are currently part of this CompositeSubscription and remove them from the CompositeSubscription so that the CompositeSubscription is empty and in an unoperative state.

      • 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).