diff --git a/rxjava-core/src/main/java/rx/Observable.java b/rxjava-core/src/main/java/rx/Observable.java index 07c89c0b195..5a703c5019e 100644 --- a/rxjava-core/src/main/java/rx/Observable.java +++ b/rxjava-core/src/main/java/rx/Observable.java @@ -5483,7 +5483,6 @@ public static Observable amb(Iterable> return create(OperationAmb.amb(sources)); } - /** * Invokes an action for each item emitted by the Observable. *

@@ -5692,42 +5691,71 @@ private boolean isInternalImplementation(Object o) { return isInternal; } } + /** - * Creates a pattern that matches when both observable sequences have an available element. - * @param right Observable sequence to match with the left sequence. - * @return Pattern object that matches when both observable sequences have an available element. + * Creates a pattern that matches when both Observable sequences have an + * available item. + *

+ * + * + * @param right Observable sequence to match with the left sequence + * @return Pattern object that matches when both Observable sequences have + * an available item + * @throws NullPointerException if right is null + * @see and() * @see MSDN: Observable.And - * @throws NullPointerException if right is null */ public Pattern2 and(Observable right) { return OperationJoinPatterns.and(this, right); } + /** - * Matches when the observable sequence has an available element and projects the element by invoking the selector function. - * @param selector Selector that will be invoked for elements in the source sequence. - * @return Plan that produces the projected results, to be fed (with other plans) to the When operator. + * Matches when the Observable sequence has an available item and + * projects the item by invoking the selector function. + *

+ * + * + * @param selector Selector that will be invoked for elements in the source + * sequence + * @return Plan that produces the projected results, to be fed (with other + * plans) to the When operator + * @throws NullPointerException if selector is null + * @see then() * @see MSDN: Observable.Then - * @throws NullPointerException if selector is null */ public Plan0 then(Func1 selector) { return OperationJoinPatterns.then(this, selector); } + /** * Joins together the results from several patterns. - * @param plans A series of plans created by use of the Then operator on patterns. - * @return An observable sequence with the results from matching several patterns. + *

+ * + * + * @param plans a series of plans created by use of the Then operator on + * patterns + * @return an Observable sequence with the results from matching several + * patterns + * @throws NullPointerException if plans is null + * @see when() * @see MSDN: Observable.When - * @throws NullPointerException if plans is null */ public static Observable when(Plan0... plans) { return create(OperationJoinPatterns.when(plans)); } + /** * Joins together the results from several patterns. - * @param plans A series of plans created by use of the Then operator on patterns. - * @return An observable sequence with the results from matching several patterns. + *

+ * + * + * @param plans a series of plans created by use of the Then operator on + * patterns + * @return an Observable sequence with the results from matching several + * patterns + * @throws NullPointerException if plans is null + * @see when() * @see MSDN: Observable.When - * @throws NullPointerException if plans is null */ public static Observable when(Iterable> plans) { if (plans == null) { @@ -5735,83 +5763,122 @@ public static Observable when(Iterable> plans) { } return create(OperationJoinPatterns.when(plans)); } + /** * Joins the results from a pattern. + *

+ * + * * @param p1 the plan to join - * @return An observable sequence with the results from matching a pattern + * @return an Observable sequence with the results from matching a pattern + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") public static Observable when(Plan0 p1) { return create(OperationJoinPatterns.when(p1)); } + /** * Joins together the results from several patterns. + *

+ * + * * @param p1 a plan * @param p2 a plan - * @return An observable sequence with the results from matching several patterns + * @return an Observable sequence with the results from matching several + * patterns + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") public static Observable when(Plan0 p1, Plan0 p2) { return create(OperationJoinPatterns.when(p1, p2)); } + /** * Joins together the results from several patterns. + *

+ * + * * @param p1 a plan * @param p2 a plan * @param p3 a plan - * @return An observable sequence with the results from matching several patterns + * @return an Observable sequence with the results from matching several + * patterns + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3) { return create(OperationJoinPatterns.when(p1, p2, p3)); } + /** * Joins together the results from several patterns. + *

+ * + * * @param p1 a plan * @param p2 a plan * @param p3 a plan * @param p4 a plan - * @return An observable sequence with the results from matching several patterns + * @return an Observable sequence with the results from matching several + * patterns + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan0 p4) { return create(OperationJoinPatterns.when(p1, p2, p3, p4)); } + /** * Joins together the results from several patterns. + *

+ * + * * @param p1 a plan * @param p2 a plan * @param p3 a plan * @param p4 a plan * @param p5 a plan - * @return An observable sequence with the results from matching several patterns + * @return an Observable sequence with the results from matching several + * patterns + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan0 p4, Plan0 p5) { return create(OperationJoinPatterns.when(p1, p2, p3, p4, p5)); } + /** * Joins together the results from several patterns. + *

+ * + * * @param p1 a plan * @param p2 a plan * @param p3 a plan * @param p4 a plan * @param p5 a plan * @param p6 a plan - * @return An observable sequence with the results from matching several patterns + * @return an Observable sequence with the results from matching several + * patterns + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan0 p4, Plan0 p5, Plan0 p6) { return create(OperationJoinPatterns.when(p1, p2, p3, p4, p5, p6)); } + /** * Joins together the results from several patterns. + *

+ * + * * @param p1 a plan * @param p2 a plan * @param p3 a plan @@ -5819,15 +5886,21 @@ public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan * @param p5 a plan * @param p6 a plan * @param p7 a plan - * @return An observable sequence with the results from matching several patterns + * @return an Observable sequence with the results from matching several + * patterns + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan0 p4, Plan0 p5, Plan0 p6, Plan0 p7) { return create(OperationJoinPatterns.when(p1, p2, p3, p4, p5, p6, p7)); } + /** * Joins together the results from several patterns. + *

+ * + * * @param p1 a plan * @param p2 a plan * @param p3 a plan @@ -5836,15 +5909,21 @@ public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan * @param p6 a plan * @param p7 a plan * @param p8 a plan - * @return An observable sequence with the results from matching several patterns + * @return an Observable sequence with the results from matching several + * patterns + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan0 p4, Plan0 p5, Plan0 p6, Plan0 p7, Plan0 p8) { return create(OperationJoinPatterns.when(p1, p2, p3, p4, p5, p6, p7, p8)); } + /** * Joins together the results from several patterns. + *

+ * + * * @param p1 a plan * @param p2 a plan * @param p3 a plan @@ -5854,7 +5933,9 @@ public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan * @param p7 a plan * @param p8 a plan * @param p9 a plan - * @return An observable sequence with the results from matching several patterns + * @return an Observable sequence with the results from matching several + * patterns + * @see when() * @see MSDN: Observable.When */ @SuppressWarnings("unchecked") @@ -5862,3 +5943,4 @@ public static Observable when(Plan0 p1, Plan0 p2, Plan0 p3, Plan return create(OperationJoinPatterns.when(p1, p2, p3, p4, p5, p6, p7, p8, p9)); } } +