Skip to content

Commit 3f23b3a

Browse files
committed
javadoc: document more exception throwing
1 parent cbd7c03 commit 3f23b3a

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

rxjava-core/src/main/java/rx/Observable.java

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1701,7 +1701,7 @@ public final static <T> Observable<T> merge(Iterable<? extends Observable<? exte
17011701
* the maximum number of Observables that may be subscribed to concurrently
17021702
* @return an Observable that emits items that are the result of flattening the items emitted by the
17031703
* Observables in the Iterable
1704-
* @throw IllegalArgumentException
1704+
* @throws IllegalArgumentException
17051705
* if {@code maxConcurrent} is less than or equal to 0
17061706
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#wiki-merge">RxJava Wiki: merge()</a>
17071707
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229923.aspx">MSDN: Observable.Merge</a>
@@ -1728,7 +1728,7 @@ public final static <T> Observable<T> merge(Iterable<? extends Observable<? exte
17281728
* the Scheduler on which to traverse the Iterable of Observables
17291729
* @return an Observable that emits items that are the result of flattening the items emitted by the
17301730
* Observables in the Iterable
1731-
* @throw IllegalArgumentException
1731+
* @throws IllegalArgumentException
17321732
* if {@code maxConcurrent} is less than or equal to 0
17331733
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#wiki-merge">RxJava Wiki: merge()</a>
17341734
* @see <a href="http://msdn.microsoft.com/en-us/library/hh244329.aspx">MSDN: Observable.Merge</a>
@@ -1795,7 +1795,7 @@ public final static <T> Observable<T> merge(Observable<? extends Observable<? ex
17951795
* the maximum number of Observables that may be subscribed to concurrently
17961796
* @return an Observable that emits items that are the result of flattening the Observables emitted by the
17971797
* {@code source} Observable
1798-
* @throw IllegalArgumentException
1798+
* @throws IllegalArgumentException
17991799
* if {@code maxConcurrent} is less than or equal to 0
18001800
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#wiki-merge">RxJava Wiki: merge()</a>
18011801
* @see <a href="http://msdn.microsoft.com/en-us/library/hh211914.aspx">MSDN: Observable.Merge</a>
@@ -2466,6 +2466,10 @@ public final static <T> Observable<Observable<T>> parallelMerge(Observable<Obser
24662466
* @param count
24672467
* the number of sequential Integers to generate
24682468
* @return an Observable that emits a range of sequential Integers
2469+
* @throws IllegalArgumentException
2470+
* if {@code count} is less than zero
2471+
* @throws IllegalArgumentException
2472+
* if {@code start} + {@code count} exceeds {@code Integer.MAX_VALUE}
24692473
* @see <a href="https://github.com/Netflix/RxJava/wiki/Creating-Observables#wiki-range">RxJava Wiki: range()</a>
24702474
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229460.aspx">MSDN: Observable.Range</a>
24712475
*/
@@ -5578,6 +5582,8 @@ public final Observable<T> repeat(Scheduler scheduler) {
55785582
* sequence
55795583
* @return an Observable that repeats the sequence of items emitted by the source Observable at most
55805584
* {@code count} times
5585+
* @throws IllegalArgumentException
5586+
* if {@code count} is less than zero
55815587
* @see <a href="https://github.com/Netflix/RxJava/wiki/Creating-Observables#wiki-repeat">RxJava Wiki: repeat()</a>
55825588
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229428.aspx">MSDN: Observable.Repeat</a>
55835589
*/
@@ -5729,6 +5735,8 @@ public final <R> Observable<R> replay(Func1<? super Observable<T>, ? extends Obs
57295735
* a {@link ConnectableObservable} that shares a single subscription to the source Observable, and
57305736
* replays no more than {@code bufferSize} items that were emitted within the window defined by
57315737
* {@code time}
5738+
* @throws IllegalArgumentException
5739+
* if {@code bufferSize} is less than zero
57325740
* @see <a href="https://github.com/Netflix/RxJava/wiki/Connectable-Observable-Operators#wiki-observablereplay">RxJava Wiki: replay()</a>
57335741
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229404.aspx">MSDN: Observable.Replay</a>
57345742
*/
@@ -5918,6 +5926,8 @@ public final ConnectableObservable<T> replay(int bufferSize, long time, TimeUnit
59185926
* @return a {@link ConnectableObservable} that shares a single subscription to the source Observable and
59195927
* replays at most {@code bufferSize} items that were emitted during the window defined by
59205928
* {@code time}
5929+
* @throws IllegalArgumentException
5930+
* if {@code bufferSize} is less than zero
59215931
* @see <a href="https://github.com/Netflix/RxJava/wiki/Connectable-Observable-Operators#wiki-observablereplay">RxJava Wiki: replay()</a>
59225932
* @see <a href="http://msdn.microsoft.com/en-us/library/hh211759.aspx">MSDN: Observable.Replay</a>
59235933
*/
@@ -6984,7 +6994,13 @@ public void onNext(T t) {
69846994
* @return a {@link Subscription} reference with which Subscribers that are {@link Observer}s can
69856995
* unsubscribe from the Observable
69866996
* @throws IllegalStateException
6997+
* if {@code subscribe()} is unable to obtain an {@code OnSubscribe<>} function
6998+
* @throws IllegalArgumentException
69876999
* if the {@link Subscriber} provided as the argument to {@code subscribe()} is {@code null}
7000+
* @throws OnErrorNotImplementedException
7001+
* if the {@link Subscriber}'s {@code onError} method is null
7002+
* @throws RuntimeException
7003+
* if the {@link Subscriber}'s {@code onError} method itself threw a {@code Throwable}
69887004
*/
69897005
public final Subscription subscribe(Subscriber<? super T> observer) {
69907006
// allow the hook to intercept and/or decorate
@@ -7363,6 +7379,8 @@ public final Observable<T> takeLast(int count, long time, TimeUnit unit) {
73637379
* @return an Observable that emits at most {@code count} items from the source Observable that were emitted
73647380
* in a specified window of time before the Observable completed, where the timing information is
73657381
* provided by the given {@code scheduler}
7382+
* @throws IllegalArgumentException
7383+
* if {@code count} is less than zero
73667384
*/
73677385
public final Observable<T> takeLast(int count, long time, TimeUnit unit, Scheduler scheduler) {
73687386
if (count < 0) {
@@ -7813,6 +7831,8 @@ public final <U, V> Observable<T> timeout(Func0<? extends Observable<U>> firstTi
78137831
* @return an Observable that mirrors the source Observable, but switches to the {@code other} Observable if
78147832
* either the first item emitted by the source Observable or any subsequent item don't arrive within
78157833
* time windows defined by the timeout selectors
7834+
* @throws NullPointerException
7835+
* if {@code timeoutSelector} is null
78167836
*/
78177837
public final <U, V> Observable<T> timeout(Func0<? extends Observable<U>> firstTimeoutSelector, Func1<? super T, ? extends Observable<V>> timeoutSelector, Observable<? extends T> other) {
78187838
if(timeoutSelector == null) {

0 commit comments

Comments
 (0)