Skip to content

Commit

Permalink
Disable scalastyle for false positives. Add Java static factory metho…
Browse files Browse the repository at this point in the history
…ds seconds(), minutes() to Duration. Add Java-friendly methods to Time too, and unit tests. Remove unnecessary math.floor from Time.floor()
  • Loading branch information
srowen committed Sep 16, 2014
1 parent 4dee32e commit 7dde949
Show file tree
Hide file tree
Showing 6 changed files with 236 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ case class Duration (private val millis: Long) {

def / (that: Duration): Double = millis.toDouble / that.millis.toDouble

// Java-friendlier versions of the above:
// Java-friendlier versions of the above. scalastyle is disabled here to avoid warnings
// on spacing around binary operators.

// scalastyle:off

def less(that: Duration): Boolean = this.<(that)

Expand All @@ -55,6 +58,8 @@ case class Duration (private val millis: Long) {

def div(that: Duration): Double = this./(that)

// scalastyle:on


def isMultipleOf(that: Duration): Boolean =
(this.millis % that.millis == 0)
Expand Down Expand Up @@ -99,4 +104,14 @@ object Minutes {
def apply(minutes: Long) = new Duration(minutes * 60000)
}

// Java-friendlier versions of the objects above.

object Duration {

// No 'milliseconds' since it would conflict with methods above. Use the constructor directly.

def seconds(seconds: Long) = Seconds(seconds)

def minutes(minutes: Long) = Minutes(minutes)

}
25 changes: 23 additions & 2 deletions streaming/src/main/scala/org/apache/spark/streaming/Time.scala
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,31 @@ case class Time(private val millis: Long) {

def - (that: Duration): Time = new Time(millis - that.milliseconds)

// Java-friendlier versions of the above. scalastyle is disabled here to avoid warnings
// on spacing around binary operators.

// scalastyle:off

def less(that: Time): Boolean = this.<(that)

def lessEq(that: Time): Boolean = this.<=(that)

def greater(that: Time): Boolean = this.>(that)

def greaterEq(that: Time): Boolean = this.>=(that)

def plus(that: Duration): Time = this.+(that)

def minus(that: Time): Duration = this.-(that)

def minus(that: Duration): Time = this.-(that)

// scalastyle:on


def floor(that: Duration): Time = {
val t = that.milliseconds
val m = math.floor(this.millis / t).toLong
new Time(m * t)
new Time((this.millis / t) * t)
}

def isMultipleOf(that: Duration): Boolean =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,14 @@ public void testDiv() {
Assert.assertEquals(200.0, new Duration(1000).div(new Duration(5)), 1.0e-12);
}

@Test
public void testSeconds() {
Assert.assertEquals(new Duration(30 * 1000), Duration.seconds(30));
}

@Test
public void testMinutes() {
Assert.assertEquals(new Duration(2 * 60 * 1000), Duration.minutes(2));
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.spark.streaming;

import org.junit.Assert;
import org.junit.Test;

public class JavaTimeSuite {

// Just testing the methods that are specially exposed for Java.
// This does not repeat all tests found in the Scala suite.

@Test
public void testLess() {
Assert.assertTrue(new Time(999).less(new Time(1000)));
}

@Test
public void testLessEq() {
Assert.assertTrue(new Time(1000).lessEq(new Time(1000)));
}

@Test
public void testGreater() {
Assert.assertTrue(new Time(1000).greater(new Time(999)));
}

@Test
public void testGreaterEq() {
Assert.assertTrue(new Time(1000).greaterEq(new Time(1000)));
}

@Test
public void testPlus() {
Assert.assertEquals(new Time(1100), new Time(1000).plus(new Duration(100)));
}

@Test
public void testMinusTime() {
Assert.assertEquals(new Duration(900), new Time(1000).minus(new Time(100)));
}

@Test
public void testMinusDuration() {
Assert.assertEquals(new Time(900), new Time(1000).minus(new Duration(100)));
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ class DurationSuite extends TestSuiteBase {
test("minus") {
assert((new Duration(1000) - new Duration(100)) == new Duration(900))
assert((new Duration(1000) - new Duration(0)) == new Duration(1000))
assert((new Duration(1000) - new Duration(1000)) == new Duration(0))
}

test("times") {
Expand Down Expand Up @@ -94,4 +95,16 @@ class DurationSuite extends TestSuiteBase {
assert(!(new Duration(1).isZero))
}

test("Milliseconds") {
assert(new Duration(100) == Milliseconds(100))
}

test("Seconds") {
assert(new Duration(30 * 1000) == Seconds(30))
}

test("Minutes") {
assert(new Duration(2 * 60 * 1000) == Minutes(2))
}

}
111 changes: 111 additions & 0 deletions streaming/src/test/scala/org/apache/spark/streaming/TimeSuite.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.spark.streaming

class TimeSuite extends TestSuiteBase {

test("less") {
assert(new Time(999) < new Time(1000))
assert(new Time(0) < new Time(1))
assert(!(new Time(1000) < new Time(999)))
assert(!(new Time(1000) < new Time(1000)))
}

test("lessEq") {
assert(new Time(999) <= new Time(1000))
assert(new Time(0) <= new Time(1))
assert(!(new Time(1000) <= new Time(999)))
assert(new Time(1000) <= new Time(1000))
}

test("greater") {
assert(!(new Time(999) > new Time(1000)))
assert(!(new Time(0) > new Time(1)))
assert(new Time(1000) > new Time(999))
assert(!(new Time(1000) > new Time(1000)))
}

test("greaterEq") {
assert(!(new Time(999) >= new Time(1000)))
assert(!(new Time(0) >= new Time(1)))
assert(new Time(1000) >= new Time(999))
assert(new Time(1000) >= new Time(1000))
}

test("plus") {
assert((new Time(1000) + new Duration(100)) == new Time(1100))
assert((new Time(1000) + new Duration(0)) == new Time(1000))
}

test("minus Time") {
assert((new Time(1000) - new Time(100)) == new Duration(900))
assert((new Time(1000) - new Time(0)) == new Duration(1000))
assert((new Time(1000) - new Time(1000)) == new Duration(0))
}

test("minus Duration") {
assert((new Time(1000) - new Duration(100)) == new Time(900))
assert((new Time(1000) - new Duration(0)) == new Time(1000))
assert((new Time(1000) - new Duration(1000)) == new Time(0))
}

test("floor") {
assert(new Time(1350).floor(new Duration(200)) == new Time(1200))
assert(new Time(1200).floor(new Duration(200)) == new Time(1200))
assert(new Time(199).floor(new Duration(200)) == new Time(0))
assert(new Time(1).floor(new Duration(1)) == new Time(1))
}

test("isMultipleOf") {
assert(new Time(1000).isMultipleOf(new Duration(5)))
assert(new Time(1000).isMultipleOf(new Duration(1000)))
assert(new Time(1000).isMultipleOf(new Duration(1)))
assert(!new Time(1000).isMultipleOf(new Duration(6)))
}

test("min") {
assert(new Time(999).min(new Time(1000)) == new Time(999))
assert(new Time(1000).min(new Time(999)) == new Time(999))
assert(new Time(1000).min(new Time(1000)) == new Time(1000))
}

test("max") {
assert(new Time(999).max(new Time(1000)) == new Time(1000))
assert(new Time(1000).max(new Time(999)) == new Time(1000))
assert(new Time(1000).max(new Time(1000)) == new Time(1000))
}

test("until") {
assert(new Time(1000).until(new Time(1100), new Duration(100)) ==
Seq(Time(1000)))
assert(new Time(1000).until(new Time(1000), new Duration(100)) ==
Seq())
assert(new Time(1000).until(new Time(1100), new Duration(30)) ==
Seq(Time(1000), Time(1030), Time(1060), Time(1090)))
}

test("to") {
assert(new Time(1000).to(new Time(1100), new Duration(100)) ==
Seq(Time(1000), Time(1100)))
assert(new Time(1000).to(new Time(1000), new Duration(100)) ==
Seq(Time(1000)))
assert(new Time(1000).to(new Time(1100), new Duration(30)) ==
Seq(Time(1000), Time(1030), Time(1060), Time(1090)))
}

}

0 comments on commit 7dde949

Please sign in to comment.