Repository: incubator-reef Updated Branches: refs/heads/master 9c5b9582a -> f7689fd9f
[REEF-521] Add missing Javadoc comments/triage TODO notes in Java code: reef-bridge-client and reef-bridge-java JIRA: [REEF-521](https://issues.apache.org/jira/browse/REEF-521) Pull request: This closes #532 Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/f7689fd9 Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/f7689fd9 Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/f7689fd9 Branch: refs/heads/master Commit: f7689fd9fdb853a6550e92004c074005e140a1f3 Parents: 9c5b958 Author: Mariia Mykhailova <[email protected]> Authored: Wed Sep 30 15:34:51 2015 -0700 Committer: Andrew Chung <[email protected]> Committed: Thu Oct 1 13:32:26 2015 -0700 ---------------------------------------------------------------------- lang/java/reef-bridge-client/pom.xml | 11 +++++++++++ lang/java/reef-bridge-java/pom.xml | 11 +++++++++++ .../org/apache/reef/javabridge/ActiveContextBridge.java | 3 +++ .../org/apache/reef/javabridge/ClosedContextBridge.java | 3 +++ .../apache/reef/javabridge/CompletedEvaluatorBridge.java | 3 +++ .../org/apache/reef/javabridge/CompletedTaskBridge.java | 3 +++ .../org/apache/reef/javabridge/ContextMessageBridge.java | 3 +++ .../apache/reef/javabridge/EvaluatorRequestorBridge.java | 3 +++ .../org/apache/reef/javabridge/FailedContextBridge.java | 3 +++ .../apache/reef/javabridge/FailedEvaluatorBridge.java | 3 +++ .../org/apache/reef/javabridge/FailedTaskBridge.java | 5 ++++- .../apache/reef/javabridge/HttpServerEventBridge.java | 3 +++ .../java/org/apache/reef/javabridge/InteropLogger.java | 3 +++ .../org/apache/reef/javabridge/InteropReturnInfo.java | 3 +++ .../main/java/org/apache/reef/javabridge/JavaBridge.java | 3 +++ .../java/org/apache/reef/javabridge/NativeBridge.java | 5 ++++- .../java/org/apache/reef/javabridge/NativeInterop.java | 4 ++++ .../org/apache/reef/javabridge/RunningTaskBridge.java | 3 +++ .../org/apache/reef/javabridge/SuspendedTaskBridge.java | 3 +++ .../org/apache/reef/javabridge/TaskMessageBridge.java | 3 +++ .../main/java/org/apache/reef/javabridge/Utilities.java | 7 +++++-- .../org/apache/reef/javabridge/generic/JobDriver.java | 3 +++ .../java/org/apache/reef/javabridge/generic/Launch.java | 2 -- .../org/apache/reef/util/logging/CLRLoggingConfig.java | 3 +++ 24 files changed, 90 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-client/pom.xml ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-client/pom.xml b/lang/java/reef-bridge-client/pom.xml index 8f60667..19ae000 100644 --- a/lang/java/reef-bridge-client/pom.xml +++ b/lang/java/reef-bridge-client/pom.xml @@ -102,6 +102,17 @@ under the License. </dependencies> <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> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/pom.xml ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/pom.xml b/lang/java/reef-bridge-java/pom.xml index 173bf50..517fe48 100644 --- a/lang/java/reef-bridge-java/pom.xml +++ b/lang/java/reef-bridge-java/pom.xml @@ -69,6 +69,17 @@ under the License. </dependencies> <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> <plugins> <plugin> <artifactId>maven-jar-plugin</artifactId> http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ActiveContextBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ActiveContextBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ActiveContextBridge.java index 48b7a0d..2c036d2 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ActiveContextBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ActiveContextBridge.java @@ -25,6 +25,9 @@ import org.apache.reef.runtime.common.driver.context.EvaluatorContext; import java.util.logging.Level; import java.util.logging.Logger; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.context.ActiveContext}. + */ public final class ActiveContextBridge extends NativeBridge implements Identifiable { private static final Logger LOG = Logger.getLogger(ActiveContextBridge.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ClosedContextBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ClosedContextBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ClosedContextBridge.java index 5cd2b6d..c82c7a1 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ClosedContextBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ClosedContextBridge.java @@ -26,6 +26,9 @@ import org.apache.reef.util.Optional; import java.util.logging.Level; import java.util.logging.Logger; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.context.ClosedContext}. + */ public class ClosedContextBridge extends NativeBridge implements ClosedContext { private static final Logger LOG = Logger.getLogger(ClosedContextBridge.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedEvaluatorBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedEvaluatorBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedEvaluatorBridge.java index 79143f6..34cc569 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedEvaluatorBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedEvaluatorBridge.java @@ -21,6 +21,9 @@ package org.apache.reef.javabridge; import org.apache.reef.driver.evaluator.CompletedEvaluator; import org.apache.reef.io.naming.Identifiable; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.evaluator.CompletedEvaluator}. + */ public class CompletedEvaluatorBridge extends NativeBridge implements Identifiable { private final CompletedEvaluator jcompletedEvaluator; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedTaskBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedTaskBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedTaskBridge.java index 03b616e..c0680f9 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedTaskBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/CompletedTaskBridge.java @@ -22,6 +22,9 @@ import org.apache.reef.annotations.audience.Private; import org.apache.reef.driver.task.CompletedTask; import org.apache.reef.io.Message; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.task.CompletedTask}. + */ @Private public final class CompletedTaskBridge extends NativeBridge implements Message { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ContextMessageBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ContextMessageBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ContextMessageBridge.java index 3ba9f2d..8b6ceb3 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ContextMessageBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/ContextMessageBridge.java @@ -20,6 +20,9 @@ package org.apache.reef.javabridge; import org.apache.reef.driver.context.ContextMessage; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.context.ContextMessage}. + */ public class ContextMessageBridge extends NativeBridge implements ContextMessage { private ContextMessage jcontextMessage; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/EvaluatorRequestorBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/EvaluatorRequestorBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/EvaluatorRequestorBridge.java index 42b6e57..34c3fbf 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/EvaluatorRequestorBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/EvaluatorRequestorBridge.java @@ -26,6 +26,9 @@ import org.apache.reef.util.logging.LoggingScopeFactory; import java.util.logging.Level; import java.util.logging.Logger; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.evaluator.EvaluatorRequestor}. + */ public final class EvaluatorRequestorBridge extends NativeBridge { private static final Logger LOG = Logger.getLogger(EvaluatorRequestorBridge.class.getName()); private final boolean isBlocked; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedContextBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedContextBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedContextBridge.java index 3f0bfce..f05c06a 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedContextBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedContextBridge.java @@ -27,6 +27,9 @@ import org.apache.reef.util.Optional; import java.util.logging.Level; import java.util.logging.Logger; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.context.FailedContext}. + */ public final class FailedContextBridge extends NativeBridge implements ContextBase { private static final Logger LOG = Logger.getLogger(FailedContextBridge.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedEvaluatorBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedEvaluatorBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedEvaluatorBridge.java index 9447185..cb567c5 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedEvaluatorBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedEvaluatorBridge.java @@ -24,6 +24,9 @@ import org.apache.reef.util.logging.LoggingScopeFactory; import java.util.logging.Logger; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.evaluator.FailedEvaluator}. + */ public class FailedEvaluatorBridge extends NativeBridge { private static final Logger LOG = Logger.getLogger(FailedEvaluatorBridge.class.getName()); private FailedEvaluator jfailedEvaluator; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedTaskBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedTaskBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedTaskBridge.java index b4bdfc5..21443a5 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedTaskBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/FailedTaskBridge.java @@ -24,6 +24,9 @@ import java.nio.charset.StandardCharsets; import java.util.logging.Level; import java.util.logging.Logger; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.task.FailedTask}. + */ public final class FailedTaskBridge extends NativeBridge { private static final Logger LOG = Logger.getLogger(FailedTaskBridge.class.getName()); @@ -47,7 +50,7 @@ public final class FailedTaskBridge extends NativeBridge { final String data = jfailedTask.getData().isPresent() ? new String(jfailedTask.getData().get(), StandardCharsets.UTF_8).replace("=", "").replace(",", "") : ""; - // TODO: deserialize/serialize with proper Avro schema + // TODO[JIRA REEF-796]: deserialize/serialize with proper Avro schema final String poorSerializedString = "Identifier=" + jfailedTask.getId().replace("=", "").replace(",", "") + ", Message=" + jfailedTask.getMessage().replace("=", "").replace(",", "") + ", Description=" + description http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/HttpServerEventBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/HttpServerEventBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/HttpServerEventBridge.java index 707ebe5..7e21085 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/HttpServerEventBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/HttpServerEventBridge.java @@ -18,6 +18,9 @@ */ package org.apache.reef.javabridge; +/** + * The Java-CLR bridge object for http server events. + */ public final class HttpServerEventBridge extends NativeBridge { private String queryString; private byte[] queryRequestData; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropLogger.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropLogger.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropLogger.java index bc19cd9..2fee14d 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropLogger.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropLogger.java @@ -22,6 +22,9 @@ import java.util.HashMap; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Logger called from CLR code. + */ public class InteropLogger { private static final Logger LOG = Logger.getLogger("InteropLogger"); private HashMap<Integer, Level> levelHashMap; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropReturnInfo.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropReturnInfo.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropReturnInfo.java index 831e090..9fb2791 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropReturnInfo.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/InteropReturnInfo.java @@ -20,6 +20,9 @@ package org.apache.reef.javabridge; import java.util.ArrayList; +/** + * Information about return codes/exceptions coming from bridge. + */ public class InteropReturnInfo { private int returnCode; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/JavaBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/JavaBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/JavaBridge.java index 6957608..4fb0b84 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/JavaBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/JavaBridge.java @@ -18,6 +18,9 @@ */ package org.apache.reef.javabridge; +/** + * TODO[JIRA REEF-383] Document/Refactor JavaBridge. + */ public class JavaBridge { private static final String CPP_BRIDGE = "JavaClrBridge"; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeBridge.java index beb2f74..2046fd3 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeBridge.java @@ -21,9 +21,12 @@ package org.apache.reef.javabridge; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Abstract bridge class. + */ public abstract class NativeBridge implements AutoCloseable { - private static final Logger LOG = Logger.getLogger(ActiveContextBridge.class.getName()); + private static final Logger LOG = Logger.getLogger(NativeBridge.class.getName()); public void onError(final String errorMessage) { LOG.log(Level.SEVERE, "Bridge received error from CLR: " + errorMessage); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeInterop.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeInterop.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeInterop.java index e87fbb5..59a8d85 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeInterop.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/NativeInterop.java @@ -22,6 +22,10 @@ import org.apache.reef.javabridge.generic.DriverRestartCompletedBridge; import java.util.HashMap; +/** + * Java interfaces of CLR/Java bridge. + * Implementations of the methods can be found at lang/cs/Org.Apache.REEF.Bridge/JavaClrBridge.cpp. + */ public final class NativeInterop { public static final String CLASS_HIERARCHY_FILENAME = "clrClassHierarchy.bin"; public static final String GLOBAL_LIBRARIES_FILENAME = "userSuppliedGlobalLibraries.txt"; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/RunningTaskBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/RunningTaskBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/RunningTaskBridge.java index 822c41e..aef8dc8 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/RunningTaskBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/RunningTaskBridge.java @@ -22,6 +22,9 @@ import org.apache.reef.driver.task.RunningTask; import java.util.logging.Logger; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.task.RunningTask}. + */ public final class RunningTaskBridge extends NativeBridge { private static final Logger LOG = Logger.getLogger(RunningTaskBridge.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/SuspendedTaskBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/SuspendedTaskBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/SuspendedTaskBridge.java index 7cca512..2360cf6 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/SuspendedTaskBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/SuspendedTaskBridge.java @@ -22,6 +22,9 @@ import org.apache.reef.driver.task.SuspendedTask; import org.apache.reef.io.Message; import org.apache.reef.io.naming.Identifiable; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.task.SuspendedTask}. + */ public final class SuspendedTaskBridge extends NativeBridge implements Identifiable, Message { private final SuspendedTask jsuspendedTask; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/TaskMessageBridge.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/TaskMessageBridge.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/TaskMessageBridge.java index 2c92e96..db23ee2 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/TaskMessageBridge.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/TaskMessageBridge.java @@ -20,6 +20,9 @@ package org.apache.reef.javabridge; import org.apache.reef.driver.task.TaskMessage; +/** + * The Java-CLR bridge object for {@link org.apache.reef.driver.task.TaskMessage}. + */ public class TaskMessageBridge extends NativeBridge { private TaskMessage jtaskMessage; private String taskId; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/Utilities.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/Utilities.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/Utilities.java index 1dd3802..2399101 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/Utilities.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/Utilities.java @@ -31,9 +31,12 @@ import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; +/** + * CLR/Java bridge utilities. + */ public final class Utilities { public static ClassHierarchy loadClassHierarchy(final String classHierarchyFile) { - // TODO The file should be created via AvroClassHierarchySerializer + // TODO[JIRA REEF-400] The file should be created via AvroClassHierarchySerializer Path p = Paths.get(classHierarchyFile); if (!Files.exists(p)) { p = Paths.get(System.getProperty("user.dir") + "/reef/global/" + classHierarchyFile); @@ -41,7 +44,7 @@ public final class Utilities { if (!Files.exists(p)) { throw new RuntimeException("cannot find file " + p.toAbsolutePath()); } - // TODO Use the AvroClassHierarchy in place of protobuf + // TODO[JIRA REEF-400] Use the AvroClassHierarchySerializer in place of protobuf try (final InputStream chin = new FileInputStream(p.toAbsolutePath().toString())) { final ClassHierarchyProto.Node root = ClassHierarchyProto.Node.parseFrom(chin); final ClassHierarchy ch = new ProtocolBufferClassHierarchy(root); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/JobDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/JobDriver.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/JobDriver.java index be38084..a49b135 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/JobDriver.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/JobDriver.java @@ -687,6 +687,9 @@ public final class JobDriver { } } + /** + * Handler for message received from the Task. + */ public final class TaskMessageHandler implements EventHandler<TaskMessage> { @Override public void onNext(final TaskMessage taskMessage) { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/Launch.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/Launch.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/Launch.java index e67176d..0d53071 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/Launch.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/javabridge/generic/Launch.java @@ -111,10 +111,8 @@ public final class Launch { .set(ClientConfiguration.ON_JOB_COMPLETED, JobClient.CompletedJobHandler.class) .set(ClientConfiguration.ON_JOB_FAILED, JobClient.FailedJobHandler.class) .set(ClientConfiguration.ON_RUNTIME_ERROR, JobClient.RuntimeErrorHandler.class) - //.set(ClientConfiguration.ON_WAKE_ERROR, JobClient.WakeErrorHandler.class ) .build(); - // TODO: Remove the injector, have stuff injected. final Injector commandLineInjector = Tang.Factory.getTang().newInjector(commandLineConf); final boolean isLocal = commandLineInjector.getNamedInstance(Local.class); final Configuration runtimeConfiguration; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/f7689fd9/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRLoggingConfig.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRLoggingConfig.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRLoggingConfig.java index 7084c53..0dcb022 100644 --- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRLoggingConfig.java +++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRLoggingConfig.java @@ -21,6 +21,9 @@ package org.apache.reef.util.logging; import java.io.IOException; import java.util.logging.LogManager; +/** + * Loader for CLR logging configuration. + */ public final class CLRLoggingConfig { public CLRLoggingConfig() throws IOException {
