From 17d7a530f685c703e7d0aca505f4d4dcc719e4c2 Mon Sep 17 00:00:00 2001 From: Ben Christensen Date: Wed, 13 Aug 2014 22:22:48 -0700 Subject: [PATCH] from(T) -> items(T) See https://github.com/Netflix/RxJava/issues/1563 for discussion. --- rxjava-core/src/main/java/rx/Observable.java | 387 ++++++++++++++++-- .../operators/OperatorSequenceEqual.java | 4 +- 2 files changed, 362 insertions(+), 29 deletions(-) diff --git a/rxjava-core/src/main/java/rx/Observable.java b/rxjava-core/src/main/java/rx/Observable.java index ce2b7641178..504adf1ae51 100644 --- a/rxjava-core/src/main/java/rx/Observable.java +++ b/rxjava-core/src/main/java/rx/Observable.java @@ -821,7 +821,7 @@ public final static Observable concat(ObservableMSDN: Observable.Concat */ public final static Observable concat(Observable t1, Observable t2) { - return concat(from(t1, t2)); + return concat(items(t1, t2)); } /** @@ -846,7 +846,7 @@ public final static Observable concat(Observable t1, Observa * @see MSDN: Observable.Concat */ public final static Observable concat(Observable t1, Observable t2, Observable t3) { - return concat(from(t1, t2, t3)); + return concat(items(t1, t2, t3)); } /** @@ -873,7 +873,7 @@ public final static Observable concat(Observable t1, Observa * @see MSDN: Observable.Concat */ public final static Observable concat(Observable t1, Observable t2, Observable t3, Observable t4) { - return concat(from(t1, t2, t3, t4)); + return concat(items(t1, t2, t3, t4)); } /** @@ -902,7 +902,7 @@ public final static Observable concat(Observable t1, Observa * @see MSDN: Observable.Concat */ public final static Observable concat(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5) { - return concat(from(t1, t2, t3, t4, t5)); + return concat(items(t1, t2, t3, t4, t5)); } /** @@ -933,7 +933,7 @@ public final static Observable concat(Observable t1, Observa * @see MSDN: Observable.Concat */ public final static Observable concat(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5, Observable t6) { - return concat(from(t1, t2, t3, t4, t5, t6)); + return concat(items(t1, t2, t3, t4, t5, t6)); } /** @@ -966,7 +966,7 @@ public final static Observable concat(Observable t1, Observa * @see MSDN: Observable.Concat */ public final static Observable concat(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5, Observable t6, Observable t7) { - return concat(from(t1, t2, t3, t4, t5, t6, t7)); + return concat(items(t1, t2, t3, t4, t5, t6, t7)); } /** @@ -1001,7 +1001,7 @@ public final static Observable concat(Observable t1, Observa * @see MSDN: Observable.Concat */ public final static Observable concat(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5, Observable t6, Observable t7, Observable t8) { - return concat(from(t1, t2, t3, t4, t5, t6, t7, t8)); + return concat(items(t1, t2, t3, t4, t5, t6, t7, t8)); } /** @@ -1038,7 +1038,7 @@ public final static Observable concat(Observable t1, Observa * @see MSDN: Observable.Concat */ public final static Observable concat(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5, Observable t6, Observable t7, Observable t8, Observable t9) { - return concat(from(t1, t2, t3, t4, t5, t6, t7, t8, t9)); + return concat(items(t1, t2, t3, t4, t5, t6, t7, t8, t9)); } /** @@ -1246,6 +1246,7 @@ public final static Observable from(Future future, long time * @see RxJava wiki: from */ public final static Observable from(Future future, Scheduler scheduler) { + // TODO in a future revision the Scheduler will become important because we'll start polling instead of blocking on the Future return create(OnSubscribeToObservableFuture.toObservableFuture(future)).subscribeOn(scheduler); } @@ -1292,7 +1293,9 @@ public final static Observable from(Iterable iterable) { * Scheduler * @see RxJava wiki: from * @see MSDN: Observable.ToObservable + * @deprecated Use subscribeOn to Schedule the work */ + @Deprecated public final static Observable from(Iterable iterable, Scheduler scheduler) { return from(iterable).subscribeOn(scheduler); } @@ -1312,7 +1315,9 @@ public final static Observable from(Iterable iterable, Sched * the type of the item * @return an Observable that emits the item * @see RxJava wiki: from + * @deprecated Use just or item instead */ + @Deprecated public final static Observable from(T t1) { return just(t1); } @@ -1334,7 +1339,9 @@ public final static Observable from(T t1) { * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2) { @@ -1360,7 +1367,9 @@ public final static Observable from(T t1, T t2) { * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2, T t3) { @@ -1388,7 +1397,9 @@ public final static Observable from(T t1, T t2, T t3) { * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2, T t3, T t4) { @@ -1418,7 +1429,9 @@ public final static Observable from(T t1, T t2, T t3, T t4) { * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2, T t3, T t4, T t5) { @@ -1450,7 +1463,9 @@ public final static Observable from(T t1, T t2, T t3, T t4, T t5) { * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6) { @@ -1484,7 +1499,9 @@ public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6) { * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6, T t7) { @@ -1520,7 +1537,9 @@ public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6, T * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T t8) { @@ -1558,7 +1577,9 @@ public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6, T * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T t8, T t9) { @@ -1598,7 +1619,9 @@ public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6, T * the type of these items * @return an Observable that emits each item * @see RxJava wiki: from + * @deprecated Use items instead */ + @Deprecated // suppress unchecked because we are using varargs inside the method @SuppressWarnings("unchecked") public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T t8, T t9, T t10) { @@ -1622,8 +1645,8 @@ public final static Observable from(T t1, T t2, T t3, T t4, T t5, T t6, T * @see RxJava wiki: from * @see MSDN: Observable.ToObservable */ - public final static Observable from(T... t1) { - return from(Arrays.asList(t1)); + public final static Observable from(T[] array) { + return from(Arrays.asList(array)); } /** @@ -1644,7 +1667,9 @@ public final static Observable from(T... t1) { * @return an Observable that emits each item in the source Array * @see RxJava wiki: from * @see MSDN: Observable.ToObservable + * @deprecated Use subscribeOn to Schedule the work */ + @Deprecated public final static Observable from(T[] items, Scheduler scheduler) { return from(Arrays.asList(items), scheduler); } @@ -1694,6 +1719,314 @@ public final static Observable interval(long interval, TimeUnit unit, Sche return create(new OnSubscribeTimerPeriodically(interval, interval, unit, scheduler)); } + /** + * Converts an item into an Observable that emits that item. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * the item + * @param + * the type of the item + * @return an Observable that emits the item + * @see RxJava wiki: from + */ + public final static Observable item(T t1) { + return just(t1); + } + + /** + * Converts two items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2) { + return from(Arrays.asList(t1, t2)); + } + + /** + * Converts three items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param t3 + * third item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2, T t3) { + return from(Arrays.asList(t1, t2, t3)); + } + + /** + * Converts four items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param t3 + * third item + * @param t4 + * fourth item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2, T t3, T t4) { + return from(Arrays.asList(t1, t2, t3, t4)); + } + + /** + * Converts five items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param t3 + * third item + * @param t4 + * fourth item + * @param t5 + * fifth item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2, T t3, T t4, T t5) { + return from(Arrays.asList(t1, t2, t3, t4, t5)); + } + + /** + * Converts six items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param t3 + * third item + * @param t4 + * fourth item + * @param t5 + * fifth item + * @param t6 + * sixth item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2, T t3, T t4, T t5, T t6) { + return from(Arrays.asList(t1, t2, t3, t4, t5, t6)); + } + + /** + * Converts seven items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param t3 + * third item + * @param t4 + * fourth item + * @param t5 + * fifth item + * @param t6 + * sixth item + * @param t7 + * seventh item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2, T t3, T t4, T t5, T t6, T t7) { + return from(Arrays.asList(t1, t2, t3, t4, t5, t6, t7)); + } + + /** + * Converts eight items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param t3 + * third item + * @param t4 + * fourth item + * @param t5 + * fifth item + * @param t6 + * sixth item + * @param t7 + * seventh item + * @param t8 + * eighth item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T t8) { + return from(Arrays.asList(t1, t2, t3, t4, t5, t6, t7, t8)); + } + + /** + * Converts nine items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param t3 + * third item + * @param t4 + * fourth item + * @param t5 + * fifth item + * @param t6 + * sixth item + * @param t7 + * seventh item + * @param t8 + * eighth item + * @param t9 + * ninth item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T t8, T t9) { + return from(Arrays.asList(t1, t2, t3, t4, t5, t6, t7, t8, t9)); + } + + /** + * Converts ten items into an Observable that emits those items. + *

+ * + *

+ *
Scheduler:
+ *
{@code from} does not operate by default on a particular {@link Scheduler}.
+ *
+ * + * @param t1 + * first item + * @param t2 + * second item + * @param t3 + * third item + * @param t4 + * fourth item + * @param t5 + * fifth item + * @param t6 + * sixth item + * @param t7 + * seventh item + * @param t8 + * eighth item + * @param t9 + * ninth item + * @param t10 + * tenth item + * @param + * the type of these items + * @return an Observable that emits each item + * @see RxJava wiki: from + */ + // suppress unchecked because we are using varargs inside the method + @SuppressWarnings("unchecked") + public final static Observable items(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T t8, T t9, T t10) { + return from(Arrays.asList(t1, t2, t3, t4, t5, t6, t7, t8, t9, t10)); + } + /** * Returns an Observable that emits a single item and then completes. *

@@ -2265,7 +2598,7 @@ public final static Observable mergeDelayError(ObservableMSDN: Observable.Merge */ public final static Observable mergeDelayError(Observable t1, Observable t2) { - return mergeDelayError(from(t1, t2)); + return mergeDelayError(items(t1, t2)); } /** @@ -2298,7 +2631,7 @@ public final static Observable mergeDelayError(Observable t1 * @see MSDN: Observable.Merge */ public final static Observable mergeDelayError(Observable t1, Observable t2, Observable t3) { - return mergeDelayError(from(t1, t2, t3)); + return mergeDelayError(items(t1, t2, t3)); } /** @@ -2333,7 +2666,7 @@ public final static Observable mergeDelayError(Observable t1 * @see MSDN: Observable.Merge */ public final static Observable mergeDelayError(Observable t1, Observable t2, Observable t3, Observable t4) { - return mergeDelayError(from(t1, t2, t3, t4)); + return mergeDelayError(items(t1, t2, t3, t4)); } /** @@ -2370,7 +2703,7 @@ public final static Observable mergeDelayError(Observable t1 * @see MSDN: Observable.Merge */ public final static Observable mergeDelayError(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5) { - return mergeDelayError(from(t1, t2, t3, t4, t5)); + return mergeDelayError(items(t1, t2, t3, t4, t5)); } /** @@ -2409,7 +2742,7 @@ public final static Observable mergeDelayError(Observable t1 * @see MSDN: Observable.Merge */ public final static Observable mergeDelayError(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5, Observable t6) { - return mergeDelayError(from(t1, t2, t3, t4, t5, t6)); + return mergeDelayError(items(t1, t2, t3, t4, t5, t6)); } /** @@ -2451,7 +2784,7 @@ public final static Observable mergeDelayError(Observable t1 * @see MSDN: Observable.Merge */ public final static Observable mergeDelayError(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5, Observable t6, Observable t7) { - return mergeDelayError(from(t1, t2, t3, t4, t5, t6, t7)); + return mergeDelayError(items(t1, t2, t3, t4, t5, t6, t7)); } /** @@ -2495,7 +2828,7 @@ public final static Observable mergeDelayError(Observable t1 */ // suppress because the types are checked by the method signature before using a vararg public final static Observable mergeDelayError(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5, Observable t6, Observable t7, Observable t8) { - return mergeDelayError(from(t1, t2, t3, t4, t5, t6, t7, t8)); + return mergeDelayError(items(t1, t2, t3, t4, t5, t6, t7, t8)); } /** @@ -2540,7 +2873,7 @@ public final static Observable mergeDelayError(Observable t1 * @see MSDN: Observable.Merge */ public final static Observable mergeDelayError(Observable t1, Observable t2, Observable t3, Observable t4, Observable t5, Observable t6, Observable t7, Observable t8, Observable t9) { - return mergeDelayError(from(t1, t2, t3, t4, t5, t6, t7, t8, t9)); + return mergeDelayError(items(t1, t2, t3, t4, t5, t6, t7, t8, t9)); } /** @@ -7694,7 +8027,7 @@ public final Observable startWith(Iterable values, Scheduler scheduler) { * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1) { - return concat(Observable. from(t1), this); + return concat(item(t1), this); } /** @@ -7717,7 +8050,7 @@ public final Observable startWith(T t1) { * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1, T t2) { - return concat(Observable. from(t1, t2), this); + return concat(items(t1, t2), this); } /** @@ -7742,7 +8075,7 @@ public final Observable startWith(T t1, T t2) { * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1, T t2, T t3) { - return concat(Observable. from(t1, t2, t3), this); + return concat(items(t1, t2, t3), this); } /** @@ -7769,7 +8102,7 @@ public final Observable startWith(T t1, T t2, T t3) { * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1, T t2, T t3, T t4) { - return concat(Observable. from(t1, t2, t3, t4), this); + return concat(items(t1, t2, t3, t4), this); } /** @@ -7798,7 +8131,7 @@ public final Observable startWith(T t1, T t2, T t3, T t4) { * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1, T t2, T t3, T t4, T t5) { - return concat(Observable. from(t1, t2, t3, t4, t5), this); + return concat(items(t1, t2, t3, t4, t5), this); } /** @@ -7829,7 +8162,7 @@ public final Observable startWith(T t1, T t2, T t3, T t4, T t5) { * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1, T t2, T t3, T t4, T t5, T t6) { - return concat(Observable. from(t1, t2, t3, t4, t5, t6), this); + return concat(items(t1, t2, t3, t4, t5, t6), this); } /** @@ -7862,7 +8195,7 @@ public final Observable startWith(T t1, T t2, T t3, T t4, T t5, T t6) { * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1, T t2, T t3, T t4, T t5, T t6, T t7) { - return concat(Observable. from(t1, t2, t3, t4, t5, t6, t7), this); + return concat(items(t1, t2, t3, t4, t5, t6, t7), this); } /** @@ -7897,7 +8230,7 @@ public final Observable startWith(T t1, T t2, T t3, T t4, T t5, T t6, T t7) { * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T t8) { - return concat(Observable. from(t1, t2, t3, t4, t5, t6, t7, t8), this); + return concat(items(t1, t2, t3, t4, t5, t6, t7, t8), this); } /** @@ -7934,7 +8267,7 @@ public final Observable startWith(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T * @see MSDN: Observable.StartWith */ public final Observable startWith(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T t8, T t9) { - return concat(Observable. from(t1, t2, t3, t4, t5, t6, t7, t8, t9), this); + return concat(items(t1, t2, t3, t4, t5, t6, t7, t8, t9), this); } /** diff --git a/rxjava-core/src/main/java/rx/internal/operators/OperatorSequenceEqual.java b/rxjava-core/src/main/java/rx/internal/operators/OperatorSequenceEqual.java index 8165d4c2b83..24d32b2cacc 100644 --- a/rxjava-core/src/main/java/rx/internal/operators/OperatorSequenceEqual.java +++ b/rxjava-core/src/main/java/rx/internal/operators/OperatorSequenceEqual.java @@ -16,7 +16,7 @@ package rx.internal.operators; import static rx.Observable.concat; -import static rx.Observable.from; +import static rx.Observable.just; import static rx.Observable.zip; import rx.Observable; import rx.functions.Func1; @@ -43,7 +43,7 @@ public Object call(T t1) { return t1; } - }), from(LOCAL_ONCOMPLETED)); + }), just(LOCAL_ONCOMPLETED)); } /**