Skip to content

Commit

Permalink
2.x composite disposable docs (#6432)
Browse files Browse the repository at this point in the history 
* 2.x: Improving NPE message in CompositeDisposable add(..) when param is null

* 2.x: Improving NPE message in CompositeDisposable addAll(..) when item in vararg param is null

* 2.x: Improved in CompositeDisposable: NPE error messages, parameter naming at methods, added @throws javadoc where applicable

* 2.x: Applied PR suggestions in javadoc and messages for CompositeDisposable
  • Loading branch information
@chronvas @akarnokd
chronvas authored and akarnokd committed Mar 15, 2019
1 parent 9a74adf commit 0bb7b4d
Showing 1 changed file with 36 additions and 31 deletions.
67 changes: 36 additions & 31 deletions src/main/java/io/reactivex/disposables/CompositeDisposable.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,26 +38,28 @@ public CompositeDisposable() {

/**
* Creates a CompositeDisposables with the given array of initial elements.
* @param resources the array of Disposables to start with
* @param disposables the array of Disposables to start with
* @throws NullPointerException if {@code disposables} or any of its array items is null
*/
public CompositeDisposable(@NonNull Disposable... resources) {
ObjectHelper.requireNonNull(resources, "resources is null");
this.resources = new OpenHashSet<Disposable>(resources.length + 1);
for (Disposable d : resources) {
ObjectHelper.requireNonNull(d, "Disposable item is null");
public CompositeDisposable(@NonNull Disposable... disposables) {
ObjectHelper.requireNonNull(disposables, "disposables is null");
this.resources = new OpenHashSet<Disposable>(disposables.length + 1);
for (Disposable d : disposables) {
ObjectHelper.requireNonNull(d, "A Disposable in the disposables array is null");
this.resources.add(d);
}
}

/**
* Creates a CompositeDisposables with the given Iterable sequence of initial elements.
* @param resources the Iterable sequence of Disposables to start with
* @param disposables the Iterable sequence of Disposables to start with
* @throws NullPointerException if {@code disposables} or any of its items is null
*/
public CompositeDisposable(@NonNull Iterable<? extends Disposable> resources) {
ObjectHelper.requireNonNull(resources, "resources is null");
public CompositeDisposable(@NonNull Iterable<? extends Disposable> disposables) {
ObjectHelper.requireNonNull(disposables, "disposables is null");
this.resources = new OpenHashSet<Disposable>();
for (Disposable d : resources) {
ObjectHelper.requireNonNull(d, "Disposable item is null");
for (Disposable d : disposables) {
ObjectHelper.requireNonNull(d, "A Disposable item in the disposables sequence is null");
this.resources.add(d);
}
}
Expand Down Expand Up @@ -88,12 +90,13 @@ public boolean isDisposed() {
/**
* Adds a disposable to this container or disposes it if the
* container has been disposed.
* @param d the disposable to add, not null
* @param disposable the disposable to add, not null
* @return true if successful, false if this container has been disposed
* @throws NullPointerException if {@code disposable} is null
*/
@Override
public boolean add(@NonNull Disposable d) {
ObjectHelper.requireNonNull(d, "d is null");
public boolean add(@NonNull Disposable disposable) {
ObjectHelper.requireNonNull(disposable, "disposable is null");
if (!disposed) {
synchronized (this) {
if (!disposed) {
Expand All @@ -102,40 +105,41 @@ public boolean add(@NonNull Disposable d) {
set = new OpenHashSet<Disposable>();
resources = set;
}
set.add(d);
set.add(disposable);
return true;
}
}
}
d.dispose();
disposable.dispose();
return false;
}

/**
* Atomically adds the given array of Disposables to the container or
* disposes them all if the container has been disposed.
* @param ds the array of Disposables
* @param disposables the array of Disposables
* @return true if the operation was successful, false if the container has been disposed
* @throws NullPointerException if {@code disposables} or any of its array items is null
*/
public boolean addAll(@NonNull Disposable... ds) {
ObjectHelper.requireNonNull(ds, "ds is null");
public boolean addAll(@NonNull Disposable... disposables) {
ObjectHelper.requireNonNull(disposables, "disposables is null");
if (!disposed) {
synchronized (this) {
if (!disposed) {
OpenHashSet<Disposable> set = resources;
if (set == null) {
set = new OpenHashSet<Disposable>(ds.length + 1);
set = new OpenHashSet<Disposable>(disposables.length + 1);
resources = set;
}
for (Disposable d : ds) {
ObjectHelper.requireNonNull(d, "d is null");
for (Disposable d : disposables) {
ObjectHelper.requireNonNull(d, "A Disposable in the disposables array is null");
set.add(d);
}
return true;
}
}
}
for (Disposable d : ds) {
for (Disposable d : disposables) {
d.dispose();
}
return false;
Expand All @@ -144,13 +148,13 @@ public boolean addAll(@NonNull Disposable... ds) {
/**
* Removes and disposes the given disposable if it is part of this
* container.
* @param d the disposable to remove and dispose, not null
* @param disposable the disposable to remove and dispose, not null
* @return true if the operation was successful
*/
@Override
public boolean remove(@NonNull Disposable d) {
if (delete(d)) {
d.dispose();
public boolean remove(@NonNull Disposable disposable) {
if (delete(disposable)) {
disposable.dispose();
return true;
}
return false;
Expand All @@ -159,12 +163,13 @@ public boolean remove(@NonNull Disposable d) {
/**
* Removes (but does not dispose) the given disposable if it is part of this
* container.
* @param d the disposable to remove, not null
* @param disposable the disposable to remove, not null
* @return true if the operation was successful
* @throws NullPointerException if {@code disposable} is null
*/
@Override
public boolean delete(@NonNull Disposable d) {
ObjectHelper.requireNonNull(d, "Disposable item is null");
public boolean delete(@NonNull Disposable disposable) {
ObjectHelper.requireNonNull(disposable, "disposables is null");
if (disposed) {
return false;
}
Expand All @@ -174,7 +179,7 @@ public boolean delete(@NonNull Disposable d) {
}

OpenHashSet<Disposable> set = resources;
if (set == null || !set.remove(d)) {
if (set == null || !set.remove(disposable)) {
return false;
}
}
Expand Down

0 comments on commit 0bb7b4d

Please sign in to comment.