Copyright (c) 2016-present, RxJava Contributors.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is
distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
the License for the specific language governing permissions and limitations under the License.
/**
* Copyright (c) 2016-present, RxJava Contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is
* distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
* the License for the specific language governing permissions and limitations under the License.
*/
package io.reactivex.observers;
import java.util.concurrent.atomic.AtomicReference;
import io.reactivex.CompletableObserver;
import io.reactivex.annotations.NonNull;
import io.reactivex.disposables.Disposable;
import io.reactivex.internal.disposables.*;
import io.reactivex.internal.functions.ObjectHelper;
import io.reactivex.internal.util.EndConsumerHelper;
An abstract CompletableObserver that allows asynchronous cancellation of its subscription and associated resources. All pre-implemented final methods are thread-safe.
Override the protected onStart() to perform initialization when this ResourceCompletableObserver is subscribed to a source.
Use the public dispose() method to dispose the sequence externally and release all resources.
To release the associated resources, one has to call dispose() in onError() and onComplete() explicitly.
Use add(Disposable) to associate resources (as Disposables) with this ResourceCompletableObserver that will be cleaned up when dispose() is called. Removing previously associated resources is not possible but one can create a CompositeDisposable, associate it with this ResourceCompletableObserver and then add/remove resources to/from the CompositeDisposable freely.
Like all other consumers, ResourceCompletableObserver can be subscribed only once. Any subsequent attempt to subscribe it to a new source will yield an IllegalStateException with message "It is not allowed to subscribe with a(n) <class name> multiple times.".
Implementation of onStart(), CompletableObserver.onError(Throwable) and CompletableObserver.onComplete() are not allowed to throw any unchecked exceptions.
Example
Disposable d =
Completable.complete().delay(1, TimeUnit.SECONDS)
.subscribeWith(new ResourceCompletableObserver() {
@Override public void onStart() {
add(Schedulers.single()
.scheduleDirect(() -> System.out.println("Time!"),
2, TimeUnit.SECONDS));
}
@Override public void onError(Throwable t) {
t.printStackTrace();
dispose();
}
@Override public void onComplete() {
System.out.println("Done!");
dispose();
}
});
// ...
d.dispose();
/**
* An abstract {@link CompletableObserver} that allows asynchronous cancellation of its subscription and associated resources.
*
* <p>All pre-implemented final methods are thread-safe.
*
* <p>Override the protected {@link #onStart()} to perform initialization when this
* {@code ResourceCompletableObserver} is subscribed to a source.
*
* <p>Use the public {@link #dispose()} method to dispose the sequence externally and release
* all resources.
*
* <p>To release the associated resources, one has to call {@link #dispose()}
* in {@code onError()} and {@code onComplete()} explicitly.
*
* <p>Use {@link #add(Disposable)} to associate resources (as {@link io.reactivex.disposables.Disposable Disposable}s)
* with this {@code ResourceCompletableObserver} that will be cleaned up when {@link #dispose()} is called.
* Removing previously associated resources is not possible but one can create a
* {@link io.reactivex.disposables.CompositeDisposable CompositeDisposable}, associate it with this
* {@code ResourceCompletableObserver} and then add/remove resources to/from the {@code CompositeDisposable}
* freely.
*
* <p>Like all other consumers, {@code ResourceCompletableObserver} can be subscribed only once.
* Any subsequent attempt to subscribe it to a new source will yield an
* {@link IllegalStateException} with message {@code "It is not allowed to subscribe with a(n) <class name> multiple times."}.
*
* <p>Implementation of {@link #onStart()}, {@link #onError(Throwable)}
* and {@link #onComplete()} are not allowed to throw any unchecked exceptions.
*
* <p>Example<pre><code>
* Disposable d =
* Completable.complete().delay(1, TimeUnit.SECONDS)
* .subscribeWith(new ResourceCompletableObserver() {
* @Override public void onStart() {
* add(Schedulers.single()
* .scheduleDirect(() -> System.out.println("Time!"),
* 2, TimeUnit.SECONDS));
* }
* @Override public void onError(Throwable t) {
* t.printStackTrace();
* dispose();
* }
* @Override public void onComplete() {
* System.out.println("Done!");
* dispose();
* }
* });
* // ...
* d.dispose();
* </code></pre>
*/
public abstract class ResourceCompletableObserver implements CompletableObserver, Disposable {
The active subscription. /** The active subscription. */
private final AtomicReference<Disposable> upstream = new AtomicReference<Disposable>();
The resource composite, can never be null. /** The resource composite, can never be null. */
private final ListCompositeDisposable resources = new ListCompositeDisposable();
Adds a resource to this ResourceObserver.
Params: - resource – the resource to add
Throws: - NullPointerException – if resource is null
/**
* Adds a resource to this ResourceObserver.
*
* @param resource the resource to add
*
* @throws NullPointerException if resource is null
*/
public final void add(@NonNull Disposable resource) {
ObjectHelper.requireNonNull(resource, "resource is null");
resources.add(resource);
}
@Override
public final void onSubscribe(@NonNull Disposable d) {
if (EndConsumerHelper.setOnce(this.upstream, d, getClass())) {
onStart();
}
}
Called once the upstream sets a Subscription on this ResourceObserver.
You can perform initialization at this moment. The default
implementation does nothing.
/**
* Called once the upstream sets a Subscription on this ResourceObserver.
*
* <p>You can perform initialization at this moment. The default
* implementation does nothing.
*/
protected void onStart() {
}
Cancels the main disposable (if any) and disposes the resources associated with
this ResourceObserver (if any).
This method can be called before the upstream calls onSubscribe at which
case the main Disposable will be immediately disposed.
/**
* Cancels the main disposable (if any) and disposes the resources associated with
* this ResourceObserver (if any).
*
* <p>This method can be called before the upstream calls onSubscribe at which
* case the main Disposable will be immediately disposed.
*/
@Override
public final void dispose() {
if (DisposableHelper.dispose(upstream)) {
resources.dispose();
}
}
Returns true if this ResourceObserver has been disposed/cancelled.
Returns: true if this ResourceObserver has been disposed/cancelled
/**
* Returns true if this ResourceObserver has been disposed/cancelled.
* @return true if this ResourceObserver has been disposed/cancelled
*/
@Override
public final boolean isDisposed() {
return DisposableHelper.isDisposed(upstream.get());
}
}