Skip to content

Add "since" annotations to javadocs for new Experimental/Beta methods #3077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 23, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/main/java/rx/Observable.java
Original file line number Diff line number Diff line change
Expand Up @@ -1750,6 +1750,7 @@ public final static <T> Observable<T> merge(Observable<? extends Observable<? ex
* @throws IllegalArgumentException
* if {@code maxConcurrent} is less than or equal to 0
* @see <a href="http://reactivex.io/documentation/operators/merge.html">ReactiveX operators documentation: Merge</a>
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
*/
@Experimental
@SuppressWarnings({"unchecked", "rawtypes"})
Expand Down Expand Up @@ -2048,11 +2049,13 @@ public final static <T> Observable<T> merge(Observable<? extends T>[] sequences)
* the maximum number of Observables that may be subscribed to concurrently
* @return an Observable that emits all of the items emitted by the Observables in the Array
* @see <a href="http://reactivex.io/documentation/operators/merge.html">ReactiveX operators documentation: Merge</a>
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
*/
@Experimental
public final static <T> Observable<T> merge(Observable<? extends T>[] sequences, int maxConcurrent) {
return merge(from(sequences), maxConcurrent);
}

/**
* Flattens an Observable that emits Observables into one Observable, in a way that allows an Observer to
* receive all successfully emitted items from all of the source Observables without being interrupted by
Expand Down Expand Up @@ -2080,6 +2083,7 @@ public final static <T> Observable<T> merge(Observable<? extends T>[] sequences,
public final static <T> Observable<T> mergeDelayError(Observable<? extends Observable<? extends T>> source) {
return source.lift(OperatorMerge.<T>instance(true));
}

/**
* Flattens an Observable that emits Observables into one Observable, in a way that allows an Observer to
* receive all successfully emitted items from all of the source Observables without being interrupted by
Expand All @@ -2106,6 +2110,7 @@ public final static <T> Observable<T> mergeDelayError(Observable<? extends Obser
* @return an Observable that emits all of the items emitted by the Observables emitted by the
* {@code source} Observable
* @see <a href="http://reactivex.io/documentation/operators/merge.html">ReactiveX operators documentation: Merge</a>
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
*/
@Experimental
public final static <T> Observable<T> mergeDelayError(Observable<? extends Observable<? extends T>> source, int maxConcurrent) {
Expand Down Expand Up @@ -5516,6 +5521,7 @@ public final Observable<T> onBackpressureDrop() {
public final Observable<T> onBackpressureBlock(int maxQueueLength) {
return lift(new OperatorOnBackpressureBlock<T>(maxQueueLength));
}

/**
* Instructs an Observable that is emitting items faster than its observer can consume them to block the
* producer thread if the number of undelivered onNext events reaches the system-wide ring buffer size.
Expand Down Expand Up @@ -9146,7 +9152,7 @@ public final <U, R> Observable<R> withLatestFrom(Observable<? extends U> other,
* Observable emits connected, non-overlapping windows. It emits the current window and opens a new one
* whenever the Observable produced by the specified {@code closingSelector} emits an item.
* <p>
* <img width="640" height="485" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/window1.png" alt="">
* <img width="640" height="460" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/window1.png" alt="">
* <dl>
* <dt><b>Backpressure Support:</b></dt>
* <dd>This operator does not support backpressure as it uses the {@code closingSelector} to control data
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/rx/observers/Subscribers.java
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ public final void onNext(T args) {
* <code>subscriber</code>, has backpressure controlled by
* <code>subscriber</code> and uses <code>subscriber</code> to
* manage unsubscription.
*
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
*/
@Experimental
public static <T> Subscriber<T> wrap(final Subscriber<? super T> subscriber) {
Expand Down