Rename to sliding and tumbling

zsxwing · zsxwing · commit 02699f9577de · 2014-07-03T11:16:04.000+08:00
diff --git a/language-adaptors/rxjava-scala/src/examples/scala/rx/lang/scala/examples/RxScalaDemo.scala b/language-adaptors/rxjava-scala/src/examples/scala/rx/lang/scala/examples/RxScalaDemo.scala
@@ -182,18 +182,23 @@ class RxScalaDemo extends JUnitSuite {
     ).toObservable.flatten(2).toBlocking.foreach(println(_))
   }
 
-  @Test def rangeAndBufferExample() {
+  @Test def tumblingBufferExample() {
     val o = Observable.from(1 to 18)
-    o.buffer(5).subscribe((l: Seq[Int]) => println(l.mkString("[", ", ", "]")))
+    o.tumblingBuffer(5).subscribe((l: Seq[Int]) => println(l.mkString("[", ", ", "]")))
   }
 
-  @Test def tumblingBufferExample() {
+  @Test def tumblingBufferExample2() {
     val o = Observable.from(1 to 18).zip(Observable.interval(100 millis)).map(_._1)
     val boundary = Observable.interval(500 millis)
     o.tumblingBuffer(boundary).toBlocking.foreach((l: Seq[Int]) => println(l.mkString("[", ", ", "]")))
   }
 
   @Test def slidingBufferExample() {
+    val o = Observable.from(1 to 18).slidingBuffer(4, 2)
+    o.subscribe(println(_))
+  }
+
+  @Test def slidingBufferExample2() {
     val open = Observable.interval(300 millis)
     val closing = Observable.interval(600 millis)
     val o = Observable.interval(100 millis).take(20).slidingBuffer(open)(_ => closing)
@@ -202,13 +207,18 @@ class RxScalaDemo extends JUnitSuite {
     }
   }
 
-  @Test def windowExample() {
-    (for ((o, i) <- Observable.from(1 to 18).window(5).zipWithIndex; n <- o)
+  @Test def slidingBufferExample3() {
+    val o = Observable.from(1 to 18).zip(Observable.interval(100 millis)).map(_._1)
+    o.slidingBuffer(500 millis, 200 millis).toBlocking.foreach((l: Seq[Int]) => println(l.mkString("[", ", ", "]")))
+  }
+
+  @Test def tumblingExample() {
+    (for ((o, i) <- Observable.from(1 to 18).tumbling(5).zipWithIndex; n <- o)
       yield s"Observable#$i emits $n"
     ).subscribe(output(_))
   }
 
-  @Test def tumblingExample() {
+  @Test def tumblingExample2() {
     val windowObservable = Observable.interval(500 millis)
     val o = Observable.from(1 to 20).zip(Observable.interval(100 millis)).map(_._1)
     (for ((o, i) <- o.tumbling(windowObservable).zipWithIndex; n <- o)
@@ -217,6 +227,22 @@ class RxScalaDemo extends JUnitSuite {
   }
 
   @Test def slidingExample() {
+    val o = Observable.from(1 to 18).sliding(4, 2)
+    (for ((o, i) <- o.zipWithIndex;
+          n <- o)
+      yield s"Observable#$i emits $n"
+    ).toBlocking.foreach(println)
+  }
+
+  @Test def slidingExample2() {
+    val o = Observable.interval(100 millis).take(20).sliding(500 millis, 200 millis)
+    (for ((o, i) <- o.zipWithIndex;
+          n <- o)
+      yield s"Observable#$i emits $n"
+    ).toBlocking.foreach(println)
+  }
+
+  @Test def slidingExample3() {
     val open = Observable.interval(300 millis)
     val closing = Observable.interval(600 millis)
     val o = Observable.interval(100 millis).take(20).sliding(open)(_ => closing)
diff --git a/language-adaptors/rxjava-scala/src/main/scala/rx/lang/scala/Observable.scala b/language-adaptors/rxjava-scala/src/main/scala/rx/lang/scala/Observable.scala
@@ -470,7 +470,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping buffers containing at most
    *         `count` produced values.
    */
-  def buffer(count: Int): Observable[Seq[T]] = {
+  def tumblingBuffer(count: Int): Observable[Seq[T]] = {
     val oJava: rx.Observable[_ <: java.util.List[_]] = asJavaObservable.buffer(count)
     Observable.jObsOfListToScObsOfSeq(oJava.asInstanceOf[rx.Observable[_ <: java.util.List[T]]])
   }
@@ -491,7 +491,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces buffers every `skip` values containing at most
    *         `count` produced values.
    */
-  def buffer(count: Int, skip: Int): Observable[Seq[T]] = {
+  def slidingBuffer(count: Int, skip: Int): Observable[Seq[T]] = {
     val oJava: rx.Observable[_ <: java.util.List[_]] = asJavaObservable.buffer(count, skip)
     Observable.jObsOfListToScObsOfSeq(oJava.asInstanceOf[rx.Observable[_ <: java.util.List[T]]])
   }
@@ -509,7 +509,7 @@ trait Observable[+T]
    * @return
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping buffers with a fixed duration.
    */
-  def buffer(timespan: Duration): Observable[Seq[T]] = {
+  def tumblingBuffer(timespan: Duration): Observable[Seq[T]] = {
     val oJava: rx.Observable[_ <: java.util.List[_]] = asJavaObservable.buffer(timespan.length, timespan.unit)
     Observable.jObsOfListToScObsOfSeq(oJava.asInstanceOf[rx.Observable[_ <: java.util.List[T]]])
   }
@@ -529,7 +529,7 @@ trait Observable[+T]
    * @return
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping buffers with a fixed duration.
    */
-  def buffer(timespan: Duration, scheduler: Scheduler): Observable[Seq[T]] = {
+  def tumblingBuffer(timespan: Duration, scheduler: Scheduler): Observable[Seq[T]] = {
     val oJava: rx.Observable[_ <: java.util.List[_]] = asJavaObservable.buffer(timespan.length, timespan.unit, scheduler)
     Observable.jObsOfListToScObsOfSeq(oJava.asInstanceOf[rx.Observable[_ <: java.util.List[T]]])
   }
@@ -549,7 +549,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping buffers which are emitted after
    *         a fixed duration or when the buffer has reached maximum capacity (which ever occurs first).
    */
-  def buffer(timespan: Duration, count: Int): Observable[Seq[T]] = {
+  def tumblingBuffer(timespan: Duration, count: Int): Observable[Seq[T]] = {
     val oJava: rx.Observable[_ <: java.util.List[_]] = asJavaObservable.buffer(timespan.length, timespan.unit, count)
     Observable.jObsOfListToScObsOfSeq(oJava.asInstanceOf[rx.Observable[_ <: java.util.List[T]]])
   }
@@ -571,7 +571,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping buffers which are emitted after
    *         a fixed duration or when the buffer has reached maximum capacity (which ever occurs first).
    */
-  def buffer(timespan: Duration, count: Int, scheduler: Scheduler): Observable[Seq[T]] = {
+  def tumblingBuffer(timespan: Duration, count: Int, scheduler: Scheduler): Observable[Seq[T]] = {
     val oJava: rx.Observable[_ <: java.util.List[_]] = asJavaObservable.buffer(timespan.length, timespan.unit, count, scheduler)
     Observable.jObsOfListToScObsOfSeq(oJava.asInstanceOf[rx.Observable[_ <: java.util.List[T]]])
   }
@@ -590,7 +590,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces new buffers periodically, and these are emitted after
    *         a fixed timespan has elapsed.
    */
-  def buffer(timespan: Duration, timeshift: Duration): Observable[Seq[T]] = {
+  def slidingBuffer(timespan: Duration, timeshift: Duration): Observable[Seq[T]] = {
     val span: Long = timespan.length
     val shift: Long = timespan.unit.convert(timeshift.length, timeshift.unit)
     val unit: TimeUnit = timespan.unit
@@ -614,7 +614,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces new buffers periodically, and these are emitted after
    *         a fixed timespan has elapsed.
    */
-  def buffer(timespan: Duration, timeshift: Duration, scheduler: Scheduler): Observable[Seq[T]] = {
+  def slidingBuffer(timespan: Duration, timeshift: Duration, scheduler: Scheduler): Observable[Seq[T]] = {
     val span: Long = timespan.length
     val shift: Long = timespan.unit.convert(timeshift.length, timeshift.unit)
     val unit: TimeUnit = timespan.unit
@@ -714,7 +714,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping windows containing at most
    *         `count` produced values.
    */
-  def window(count: Int): Observable[Observable[T]] = {
+  def tumbling(count: Int): Observable[Observable[T]] = {
     // this unnecessary ascription is needed because of this bug (without, compiler crashes):
     // https://issues.scala-lang.org/browse/SI-7818
     Observable.jObsOfJObsToScObsOfScObs(asJavaObservable.window(count)) : Observable[Observable[T]]
@@ -734,7 +734,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces windows every `skip` values containing at most
    *         `count` produced values.
    */
-  def window(count: Int, skip: Int): Observable[Observable[T]] = {
+  def sliding(count: Int, skip: Int): Observable[Observable[T]] = {
     Observable.jObsOfJObsToScObsOfScObs(asJavaObservable.window(count, skip))
       : Observable[Observable[T]] // SI-7818
   }
@@ -750,7 +750,7 @@ trait Observable[+T]
    * @return
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping windows with a fixed duration.
    */
-  def window(timespan: Duration): Observable[Observable[T]] = {
+  def tumbling(timespan: Duration): Observable[Observable[T]] = {
     Observable.jObsOfJObsToScObsOfScObs(asJavaObservable.window(timespan.length, timespan.unit))
       : Observable[Observable[T]] // SI-7818
   }
@@ -768,7 +768,7 @@ trait Observable[+T]
    * @return
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping windows with a fixed duration.
    */
-  def window(timespan: Duration, scheduler: Scheduler): Observable[Observable[T]] = {
+  def tumbling(timespan: Duration, scheduler: Scheduler): Observable[Observable[T]] = {
     Observable.jObsOfJObsToScObsOfScObs(asJavaObservable.window(timespan.length, timespan.unit, scheduler))
       : Observable[Observable[T]] // SI-7818
   }
@@ -788,7 +788,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping windows which are emitted after
    *         a fixed duration or when the window has reached maximum capacity (which ever occurs first).
    */
-  def window(timespan: Duration, count: Int): Observable[Observable[T]] = {
+  def tumbling(timespan: Duration, count: Int): Observable[Observable[T]] = {
     Observable.jObsOfJObsToScObsOfScObs(asJavaObservable.window(timespan.length, timespan.unit, count))
       : Observable[Observable[T]] // SI-7818
   }
@@ -810,7 +810,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces connected non-overlapping windows which are emitted after
    *         a fixed duration or when the window has reached maximum capacity (which ever occurs first).
    */
-  def window(timespan: Duration, count: Int, scheduler: Scheduler): Observable[Observable[T]] = {
+  def tumbling(timespan: Duration, count: Int, scheduler: Scheduler): Observable[Observable[T]] = {
     Observable.jObsOfJObsToScObsOfScObs(asJavaObservable.window(timespan.length, timespan.unit, count, scheduler))
       : Observable[Observable[T]] // SI-7818
   }
@@ -829,7 +829,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces new windows periodically, and these are emitted after
    *         a fixed timespan has elapsed.
    */
-  def window(timespan: Duration, timeshift: Duration): Observable[Observable[T]] = {
+  def sliding(timespan: Duration, timeshift: Duration): Observable[Observable[T]] = {
     val span: Long = timespan.length
     val shift: Long = timespan.unit.convert(timeshift.length, timeshift.unit)
     val unit: TimeUnit = timespan.unit
@@ -853,7 +853,7 @@ trait Observable[+T]
    *         An [[rx.lang.scala.Observable]] which produces new windows periodically, and these are emitted after
    *         a fixed timespan has elapsed.
    */
-  def window(timespan: Duration, timeshift: Duration, scheduler: Scheduler): Observable[Observable[T]] = {
+  def sliding(timespan: Duration, timeshift: Duration, scheduler: Scheduler): Observable[Observable[T]] = {
     val span: Long = timespan.length
     val shift: Long = timespan.unit.convert(timeshift.length, timeshift.unit)
     val unit: TimeUnit = timespan.unit
diff --git a/language-adaptors/rxjava-scala/src/test/scala/rx/lang/scala/CompletenessTest.scala b/language-adaptors/rxjava-scala/src/test/scala/rx/lang/scala/CompletenessTest.scala
@@ -71,8 +71,14 @@ class CompletenessTest extends JUnitSuite {
       "aggregate(R, Func2[R, _ >: T, R])" -> "foldLeft(R)((R, T) => R)",
       "all(Func1[_ >: T, Boolean])" -> "forall(T => Boolean)",
       "asObservable()" -> unnecessary,
-      "buffer(Long, Long, TimeUnit)" -> "buffer(Duration, Duration)",
-      "buffer(Long, Long, TimeUnit, Scheduler)" -> "buffer(Duration, Duration, Scheduler)",
+      "buffer(Int)" -> "tumblingBuffer(Int)",
+      "buffer(Int, Int)" -> "slidingBuffer(Int, Int)",
+      "buffer(Long, TimeUnit)" -> "tumblingBuffer(Duration)",
+      "buffer(Long, TimeUnit, Int)" -> "tumblingBuffer(Duration, Int)",
+      "buffer(Long, TimeUnit, Int, Scheduler)" -> "tumblingBuffer(Duration, Int, Scheduler)",
+      "buffer(Long, TimeUnit, Scheduler)" -> "tumblingBuffer(Duration, Scheduler)",
+      "buffer(Long, Long, TimeUnit)" -> "slidingBuffer(Duration, Duration)",
+      "buffer(Long, Long, TimeUnit, Scheduler)" -> "slidingBuffer(Duration, Duration, Scheduler)",
       "buffer(Func0[_ <: Observable[_ <: TClosing]])" -> "tumblingBuffer(=> Observable[Any])",
       "buffer(Observable[B])" -> "tumblingBuffer(=> Observable[Any])",
       "buffer(Observable[B], Int)" -> "tumblingBuffer(Observable[Any], Int)",
@@ -181,11 +187,17 @@ class CompletenessTest extends JUnitSuite {
       "toMultimap(Func1[_ >: T, _ <: K], Func1[_ >: T, _ <: V], Func0[_ <: Map[K, Collection[V]]], Func1[_ >: K, _ <: Collection[V]])" -> "toMultimap(T => K, T => V, () => M, K => B)",
       "toSortedList()" -> "[Sorting is already done in Scala's collection library, use `.toSeq.map(_.sorted)`]",
       "toSortedList(Func2[_ >: T, _ >: T, Integer])" -> "[Sorting is already done in Scala's collection library, use `.toSeq.map(_.sortWith(f))`]",
+      "window(Int)" -> "tumbling(Int)",
+      "window(Int, Int)" -> "sliding(Int, Int)",
+      "window(Long, TimeUnit)" -> "tumbling(Duration)",
+      "window(Long, TimeUnit, Int)" -> "tumbling(Duration, Int)",
+      "window(Long, TimeUnit, Int, Scheduler)" -> "tumbling(Duration, Int, Scheduler)",
+      "window(Long, TimeUnit, Scheduler)" -> "tumbling(Duration, Scheduler)",
       "window(Observable[U])" -> "tumbling(=> Observable[Any])",
       "window(Func0[_ <: Observable[_ <: TClosing]])" -> "tumbling(=> Observable[Any])",
       "window(Observable[_ <: TOpening], Func1[_ >: TOpening, _ <: Observable[_ <: TClosing]])" -> "sliding(Observable[Opening])(Opening => Observable[Any])",
-      "window(Long, Long, TimeUnit)" -> "window(Duration, Duration)",
-      "window(Long, Long, TimeUnit, Scheduler)" -> "window(Duration, Duration, Scheduler)",
+      "window(Long, Long, TimeUnit)" -> "sliding(Duration, Duration)",
+      "window(Long, Long, TimeUnit, Scheduler)" -> "sliding(Duration, Duration, Scheduler)",
 
       // manually added entries for Java static methods
       "amb(Iterable[_ <: Observable[_ <: T]])" -> "amb(Observable[T]*)",
