Skip to content

Javadoc updates (longCount, sample(sampler)) #597

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.

Sign up for GitHub

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
Dec 10, 2013
Merged

Javadoc updates (longCount, sample(sampler)) #597

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ceb0574
More precise marble diagram for the case when zip() takes an Observab…
DavidMGross Dec 6, 2013
a67d8a1
Merge branch 'master' of https://github.com/Netflix/RxJava into docs
DavidMGross Dec 9, 2013
9979fa7
* corrects grammar of sequenceEqual() javadoc
DavidMGross Dec 9, 2013
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
24 changes: 13 additions & 11 deletions rxjava-core/src/main/java/rx/Observable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2297,16 +2297,16 @@ public static <T> Observable<T> from(Future<? extends T> future, long timeout, T
}

/**
* Returns an Observable that emits a Boolean value that indicate
* Returns an Observable that emits a Boolean value that indicates
* whether two sequences are equal by comparing the elements pairwise.
* <p>
* <img width="640" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/sequenceEqual.png">
*
* @param first the first Observable to compare
* @param second the second Observable to compare
* @param <T> the type of items emitted by each Observable
* @return an Observable that emits a Boolean value that indicate
* whether two sequences are equal by comparing the elements pairwise.
* @return an Observable that emits a Boolean value that indicates
* whether two sequences are equal by comparing the elements pairwise
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable-Utility-Operators#sequenceequal">RxJava Wiki: sequenceEqual()</a>
*/
public static <T> Observable<Boolean> sequenceEqual(Observable<? extends T> first, Observable<? extends T> second) {
Expand All @@ -2322,7 +2322,7 @@ public Boolean call(T first, T second) {
}

/**
* Returns an Observable that emits a Boolean value that indicate
* Returns an Observable that emits a Boolean value that indicates
* whether two sequences are equal by comparing the elements pairwise
* based on the results of a specified equality function.
* <p>
Expand All @@ -2333,8 +2333,8 @@ public Boolean call(T first, T second) {
* @param equality a function used to compare items emitted by both
* Observables
* @param <T> the type of items emitted by each Observable
* @return an Observable that emits a Boolean value that indicate
* whether two sequences are equal by comparing the elements pairwise.
* @return an Observable that emits a Boolean value that indicates
* whether two sequences are equal by comparing the elements pairwise
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable-Utility-Operators#sequenceequal">RxJava Wiki: sequenceEqual()</a>
*/
public static <T> Observable<Boolean> sequenceEqual(Observable<? extends T> first, Observable<? extends T> second, Func2<? super T, ? super T, Boolean> equality) {
Expand Down Expand Up @@ -3311,7 +3311,7 @@ public Observable<Observable<T>> window(long timespan, long timeshift, TimeUnit
* invoke {@code onNext} as many times as the number of {@code onNext}
* invokations of the source Observable that emits the fewest items.
* <p>
* <img width="640" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/zip.png">
* <img width="640" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/zip.o.png">
*
* @param ws an Observable of source Observables
* @param zipFunction a function that, when applied to an item emitted by
Expand Down Expand Up @@ -3871,7 +3871,7 @@ public Observable<T> reduce(Func2<T, T, T> accumulator) {
*
* @return an Observable that emits the number of counted elements of the
* source Observable as its single item
* @see <a href="https://github.com/Netflix/RxJava/wiki/Mathematical-Operators#count">RxJava Wiki: count()</a>
* @see <a href="https://github.com/Netflix/RxJava/wiki/Mathematical-Operators#count-and-longcount">RxJava Wiki: count()</a>
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229470.aspx">MSDN: Observable.Count</a>
* @see #longCount()
*/
Expand Down Expand Up @@ -4475,12 +4475,14 @@ public Observable<T> sample(long period, TimeUnit unit, Scheduler scheduler) {
* Return an Observable that emits the results of sampling the items
* emitted by this Observable when the <code>sampler</code>
* Observable produces an item or completes.
* <p>
* <img width="640" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/sample.o.png">
*
* @param sampler the Observable to use for sampling this
*
* @return an Observable that emits the results of sampling the items
* emitted by this Observable when the <code>sampler</code>
* Observable produces an item or completes.
* @see <a href="https://github.com/Netflix/RxJava/wiki/Filtering-Observables#sample-or-throttlelast">RxJava Wiki: sample()</a>
*/
public <U> Observable<T> sample(Observable<U> sampler) {
return create(new OperationSample.SampleWithObservable<T, U>(this, sampler));
Expand Down Expand Up @@ -5198,11 +5200,11 @@ public Observable<T> last() {
* Returns an Observable that counts the total number of items in the
* source Observable as a 64 bit long.
* <p>
* <img width="640" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/count.png">
* <img width="640" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/longCount.png">
*
* @return an Observable that emits the number of counted elements of the
* source Observable as its single, 64 bit long item
* @see <a href="https://github.com/Netflix/RxJava/wiki/Mathematical-Operators#count">RxJava Wiki: count()</a>
* @see <a href="https://github.com/Netflix/RxJava/wiki/Mathematical-Operators#count-and-longcount">RxJava Wiki: count()</a>
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229120.aspx">MSDN: Observable.LongCount</a>
* @see #count()
*/
Expand Down