You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by bg...@apache.org on 2015/11/06 04:01:55 UTC

incubator-reef git commit: [REEF-535] Triage TODO notes in reef-wake

Repository: incubator-reef
Updated Branches:
  refs/heads/master 45a861f0f -> 8f1e78f6a


[REEF-535] Triage TODO notes in reef-wake

JIRA:
  [REEF-535](https://issues.apache.org/jira/browse/REEF-535)

Pull request:
  This closes #615


Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/8f1e78f6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/8f1e78f6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/8f1e78f6

Branch: refs/heads/master
Commit: 8f1e78f6a7fa933cab1426c803adae11bfe627ca
Parents: 45a861f
Author: Mariia Mykhailova <ma...@apache.org>
Authored: Mon Nov 2 15:12:42 2015 -0800
Committer: Byung-Gon Chun <bg...@apache.org>
Committed: Fri Nov 6 12:00:57 2015 +0900

----------------------------------------------------------------------
 lang/java/reef-wake/pom.xml                            | 13 +++++++++++++
 .../apache/reef/wake/impl/BlockingEventHandler.java    |  6 +++---
 .../java/org/apache/reef/wake/impl/ForkPoolStage.java  |  2 +-
 .../java/org/apache/reef/wake/impl/WakeSharedPool.java |  7 +------
 .../org/apache/reef/wake/rx/impl/TimeoutSubject.java   |  4 +++-
 .../org/apache/reef/wake/storage/FileIdentifier.java   |  2 ++
 .../org/apache/reef/wake/storage/package-info.java     |  2 +-
 7 files changed, 24 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/8f1e78f6/lang/java/reef-wake/pom.xml
----------------------------------------------------------------------
diff --git a/lang/java/reef-wake/pom.xml b/lang/java/reef-wake/pom.xml
index 5862a02..03747cb 100644
--- a/lang/java/reef-wake/pom.xml
+++ b/lang/java/reef-wake/pom.xml
@@ -36,4 +36,17 @@ under the License.
         <module>wake</module>
     </modules>
 
+    <build>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-checkstyle-plugin</artifactId>
+                    <configuration>
+                        <configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation>
+                    </configuration>
+                </plugin>
+            </plugins>
+        </pluginManagement>
+    </build>
 </project>

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/8f1e78f6/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/BlockingEventHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/BlockingEventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/BlockingEventHandler.java
index 60604d3..a640f49 100644
--- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/BlockingEventHandler.java
+++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/BlockingEventHandler.java
@@ -40,7 +40,7 @@ public final class BlockingEventHandler<T> implements EventHandler<T> {
   private final int expectedSize;
   private final EventHandler<Iterable<T>> destination;
   private final AtomicInteger cursor;
-  // TODO: a queue is likely overly conservative given that we only need
+  // TODO[JIRA REEF-911]: a queue is likely overly conservative given that we only need
   // to preserve order of those pairs of events that didn't race (have an ordering)
   private BlockingQueue<T> events = new LinkedBlockingQueue<>();
 
@@ -56,7 +56,7 @@ public final class BlockingEventHandler<T> implements EventHandler<T> {
     final int newCursor = this.cursor.incrementAndGet();
 
     if (newCursor % expectedSize == 0) {
-      // FIXME: There is a race here where the person draining the events might
+      // TODO[JIRA REEF-911]: There is a race here where the person draining the events might
       // not include their event as the last one. I'm going to assume this does not
       // matter, since all events will still be drained exactly once by someone in
       // the proper order
@@ -67,7 +67,7 @@ public final class BlockingEventHandler<T> implements EventHandler<T> {
         // drainTo(maxElements) does not suffice because it has undefined behavior for
         // any modifications (a better spec would possibly be undefined behavior except for appends)
 
-        // TODO: a non-locking implementation will simply atomically update the head of the 
+        // TODO[JIRA REEF-911]: a non-locking implementation will simply atomically update the head of the
         // queue to index=expectedSize, so that the drainer may drain without synchronization
         for (int i = 0; i < expectedSize; i++) {
           nonConcurrent.add(events.poll());

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/8f1e78f6/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ForkPoolStage.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ForkPoolStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ForkPoolStage.java
index 9018e1d..1cf6840 100644
--- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ForkPoolStage.java
+++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ForkPoolStage.java
@@ -57,7 +57,7 @@ public class ForkPoolStage<T> extends AbstractEStage<T> {
     super(stageName);
     this.pool = sharedPool;
     this.handler = handler;
-    //TODO: should WakeSharedPool register its stages?
+    //TODO[JIRA REEF-911]: should WakeSharedPool register its stages?
 
     StageManager.instance().register(this);
   }

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/8f1e78f6/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeSharedPool.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeSharedPool.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeSharedPool.java
index 8a73f3a..1d826c7 100644
--- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeSharedPool.java
+++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeSharedPool.java
@@ -62,7 +62,7 @@ public class WakeSharedPool implements Stage {
         new Thread.UncaughtExceptionHandler() {
           @Override
           public void uncaughtException(final Thread t, final Throwable e) {
-            // TODO: need to pass this upwards to REEF can grab it
+            // TODO[JIRA REEF-911]: need to pass this upwards to REEF can grab it
           }
         },
         // async mode turned on so a task that invokes other tasks does not have to join on them.
@@ -74,11 +74,6 @@ public class WakeSharedPool implements Stage {
     StageManager.instance().register(this);
   }
 
-  // TODO do we need this?
-  //public ForkJoinPool pool() {
-  //  return pool;
-  //}
-
   @Inject
   public WakeSharedPool() {
     this(DEFAULT_PARALLELISM);

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/8f1e78f6/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/rx/impl/TimeoutSubject.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/rx/impl/TimeoutSubject.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/rx/impl/TimeoutSubject.java
index f53ac10..71ba769 100644
--- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/rx/impl/TimeoutSubject.java
+++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/rx/impl/TimeoutSubject.java
@@ -27,7 +27,9 @@ import java.util.concurrent.TimeoutException;
  * A class implementing Subject<T> with timeout.
  *
  * @param <T>
+ * @deprecated in 0.14 as unused
  */
+@Deprecated
 public class TimeoutSubject<T> implements Subject<T, T> {
   private Thread timeBomb;
   private Observer<T> destination;
@@ -71,7 +73,7 @@ public class TimeoutSubject<T> implements Subject<T, T> {
       }
     }
     if (!wasFinished) {
-      // TODO: change Subject to specify conversion to T
+      // TODO[JIRA unneeded due to deprecation]: change Subject to specify conversion to T
       destination.onNext(value);
       destination.onCompleted();
     }

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/8f1e78f6/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/FileIdentifier.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/FileIdentifier.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/FileIdentifier.java
index 40927af..6884714 100644
--- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/FileIdentifier.java
+++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/FileIdentifier.java
@@ -24,7 +24,9 @@ import java.net.URISyntaxException;
 
 /**
  * An identifier has a File URI.
+ * @deprecated in 0.14 as unused
  */
+@Deprecated
 public class FileIdentifier implements StorageIdentifier {
   private final File f;
 

http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/8f1e78f6/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/package-info.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/package-info.java
index 33f76a5..af2cde4 100644
--- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/package-info.java
+++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/storage/package-info.java
@@ -17,6 +17,6 @@
  * under the License.
  */
 /**
- * TODO: Document.
+ * Deprecated in 0.14.
  */
 package org.apache.reef.wake.storage;