rx.javafx.sources.CompositeObservable Maven / Gradle / Ivy
/**
* Copyright 2016 Netflix, Inc.
*
* 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 rx.javafx.sources;
import rx.Observable;
import rx.Subscription;
import rx.annotations.Beta;
import rx.subjects.PublishSubject;
import rx.subjects.SerializedSubject;
import rx.subscriptions.CompositeSubscription;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
/**
* A CompositeObservable can merge multiple event source Observables that can be added/removed at any time,
* affecting all Subscribers regardless of when they subscribed. This is especially helpful for merging
* multiple UI event sources. You can also pass a Transformer to perform
* further operations on the combined Observable that is returned
*
* @param
*/
public final class CompositeObservable {
private final SerializedSubject subject;
private final Observable output;
/**
* Creates a new CompositeObservable
*/
public CompositeObservable() {
this(null);
}
/**
* Creates a new CompositeObservable with the provided transformations applied to the returned Observable
* yield from `toObservable()`. For instance, you can pass `obs -> obs.replay(1).refCount()` to make this CompositeObservable
* @param transformer
*/
public CompositeObservable(Observable.Transformer transformer) {
subject = PublishSubject.create().toSerialized();
Observable updatingSource = subject.asObservable();
if (transformer == null) {
output = updatingSource;
} else {
output = updatingSource.compose(transformer);
}
}
/**
* Returns the `Observable` combining all the source Observables, with any transformations that were specified
* on construction.
* @return
*/
public Observable toObservable() {
return output;
}
public Subscription add(Observable observable) {
return observable.subscribe(subject);
}
public CompositeSubscription addAll(Observable... observables) {
final CompositeSubscription subscriptions = new CompositeSubscription();
Arrays.stream(observables).map(this::add).forEach(subscriptions::add);
return subscriptions;
}
}