CompositeDisposable (RxJava Javadoc 3.0.0-RC4)

java.lang.Object
- io.reactivex.rxjava3.disposables.CompositeDisposable

All Implemented Interfaces:

Disposable, io.reactivex.rxjava3.internal.disposables.DisposableContainer
```
public final class CompositeDisposable
extends Object
implements Disposable, io.reactivex.rxjava3.internal.disposables.DisposableContainer
```
A disposable container that can hold onto multiple other disposables and offers O(1) add and removal complexity.

Constructor Summary

Constructors
Constructor and Description
`CompositeDisposable()` Creates an empty CompositeDisposable.
`CompositeDisposable(Disposable... disposables)` Creates a CompositeDisposables with the given array of initial elements.
`CompositeDisposable(Iterable<? extends Disposable> disposables)` Creates a CompositeDisposables with the given Iterable sequence of initial elements.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(Disposable disposable)` Adds a disposable to this container or disposes it if the container has been disposed.
`boolean`	`addAll(Disposable... disposables)` Atomically adds the given array of Disposables to the container or disposes them all if the container has been disposed.
`void`	`clear()` Atomically clears the container, then disposes all the previously contained Disposables.
`boolean`	`delete(Disposable disposable)` Removes (but does not dispose) the given disposable if it is part of this container.
`void`	`dispose()` Dispose the resource, the operation should be idempotent.
`boolean`	`isDisposed()` Returns true if this resource has been disposed.
`boolean`	`remove(Disposable disposable)` Removes and disposes the given disposable if it is part of this container.
`int`	`size()` Returns the number of currently held Disposables.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CompositeDisposable
```
public CompositeDisposable()
```
    Creates an empty CompositeDisposable.
  - CompositeDisposable
```
public CompositeDisposable(@NonNull
                           Disposable... disposables)
```
    Creates a CompositeDisposables with the given array of initial elements.
    
    Parameters:
    
    disposables - the array of Disposables to start with
    
    Throws:
    
    NullPointerException - if disposables or any of its array items is null
  - CompositeDisposable
```
public CompositeDisposable(@NonNull
                           Iterable<? extends Disposable> disposables)
```
    Creates a CompositeDisposables with the given Iterable sequence of initial elements.
    
    Parameters:
    
    disposables - the Iterable sequence of Disposables to start with
    
    Throws:
    
    NullPointerException - if disposables or any of its items is null
- Method Detail
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Dispose the resource, the operation should be idempotent.
    
    Specified by:
    
    dispose in interface Disposable
  - isDisposed
```
public boolean isDisposed()
```
    Description copied from interface: Disposable
    
    Returns true if this resource has been disposed.
    
    Specified by:
    
    isDisposed in interface Disposable
    
    Returns:
    
    true if this resource has been disposed
  - add
```
public boolean add(@NonNull
                   Disposable disposable)
```
    Adds a disposable to this container or disposes it if the container has been disposed.
    
    Specified by:
    
    add in interface io.reactivex.rxjava3.internal.disposables.DisposableContainer
    
    Parameters:
    
    disposable - the disposable to add, not null
    
    Returns:
    
    true if successful, false if this container has been disposed
    
    Throws:
    
    NullPointerException - if disposable is null
  - addAll
```
public boolean addAll(@NonNull
                      Disposable... disposables)
```
    Atomically adds the given array of Disposables to the container or disposes them all if the container has been disposed.
    
    Parameters:
    
    disposables - the array of Disposables
    
    Returns:
    
    true if the operation was successful, false if the container has been disposed
    
    Throws:
    
    NullPointerException - if disposables or any of its array items is null
  - remove
```
public boolean remove(@NonNull
                      Disposable disposable)
```
    Removes and disposes the given disposable if it is part of this container.
    
    Specified by:
    
    remove in interface io.reactivex.rxjava3.internal.disposables.DisposableContainer
    
    Parameters:
    
    disposable - the disposable to remove and dispose, not null
    
    Returns:
    
    true if the operation was successful
  - delete
```
public boolean delete(@NonNull
                      Disposable disposable)
```
    Removes (but does not dispose) the given disposable if it is part of this container.
    
    Specified by:
    
    delete in interface io.reactivex.rxjava3.internal.disposables.DisposableContainer
    
    Parameters:
    
    disposable - the disposable to remove, not null
    
    Returns:
    
    true if the operation was successful
    
    Throws:
    
    NullPointerException - if disposable is null
  - clear
```
public void clear()
```
    Atomically clears the container, then disposes all the previously contained Disposables.
  - size
```
public int size()
```
    Returns the number of currently held Disposables.
    
    Returns:
    
    the number of currently held Disposables

Class CompositeDisposable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompositeDisposable

CompositeDisposable

CompositeDisposable

Method Detail

dispose

isDisposed

add

addAll

remove

delete

clear

size