You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by we...@apache.org on 2015/06/04 09:38:57 UTC
[5/6] incubator-reef git commit: [REEF-333] Fix 'First sentence ...'
JavaDoc error
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java
index 1605118..7c0baa7 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java
@@ -99,7 +99,7 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
private Boolean relaxLocality;
/**
- * Create a builder from an existing ResourceRequestEvent
+ * Create a builder from an existing ResourceRequestEvent.
*/
public Builder mergeFrom(final ResourceRequestEvent resourceRequestEvent) {
this.resourceCount = resourceRequestEvent.getResourceCount();
@@ -121,7 +121,7 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
}
/**
- * Add an entry to the nodeNameList
+ * Add an entry to the nodeNameList.
* @see ResourceRequestEvent#getNodeNameList()
*/
public Builder addNodeName(final String nodeName) {
@@ -130,7 +130,7 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
}
/**
- * Add an entry to rackNameList
+ * Add an entry to rackNameList.
* @see ResourceRequestEvent#getRackNameList()
*/
public Builder addRackName(final String rackName) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/ContextRepresenters.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/ContextRepresenters.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/ContextRepresenters.java
index a8b8606..9bea71c 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/ContextRepresenters.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/ContextRepresenters.java
@@ -101,7 +101,7 @@ public final class ContextRepresenters {
/**
- * Process a heartbeat from a context
+ * Process a heartbeat from a context.
*
* @param contextStatusProto
* @param notifyClientOnNewActiveContext
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/package-info.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/package-info.java
index 9154c74..245430f 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/package-info.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/context/package-info.java
@@ -17,10 +17,10 @@
* under the License.
*/
/**
- * Implementations of Driver-Side representations of Contexts running on an Evaluator
+ * Implementations of Driver-Side representations of Contexts running on an Evaluator.
*/
@DriverSide
@Private package org.apache.reef.runtime.common.driver.context;
import org.apache.reef.annotations.audience.DriverSide;
-import org.apache.reef.annotations.audience.Private;
\ No newline at end of file
+import org.apache.reef.annotations.audience.Private;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java
index 950f05d..e59b11c 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java
@@ -70,7 +70,7 @@ final class AllocatedEvaluatorImpl implements AllocatedEvaluator {
*/
private final Collection<File> files = new HashSet<>();
/**
- * The set of libraries
+ * The set of libraries.
*/
private final Collection<File> libraries = new HashSet<>();
@@ -244,7 +244,7 @@ final class AllocatedEvaluatorImpl implements AllocatedEvaluator {
}
/**
- * Utility to build a ConfigurationBuilder from an Optional<Configuration></Configuration>
+ * Utility to build a ConfigurationBuilder from an Optional<Configuration></Configuration>.
*/
private static ConfigurationBuilder getConfigurationBuilder(final Optional<Configuration> configuration) {
if (configuration.isPresent()) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorDescriptorImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorDescriptorImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorDescriptorImpl.java
index 6133fc4..440c8cb 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorDescriptorImpl.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorDescriptorImpl.java
@@ -25,7 +25,7 @@ import org.apache.reef.driver.evaluator.EvaluatorDescriptor;
import org.apache.reef.driver.evaluator.EvaluatorProcess;
/**
- * A simple all-data implementation of EvaluatorDescriptor
+ * A simple all-data implementation of EvaluatorDescriptor.
*/
@Private
@DriverSide
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java
index 5bbc089..f58fe5e 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java
@@ -156,7 +156,7 @@ public final class EvaluatorManager implements Identifiable, AutoCloseable {
}
/**
- * Get the id of current job/application
+ * Get the id of current job/application.
*/
public static String getJobIdentifier() {
// TODO: currently we obtain the job id directly by parsing execution (container) directory path
@@ -248,7 +248,7 @@ public final class EvaluatorManager implements Identifiable, AutoCloseable {
}
/**
- * EvaluatorException will trigger is FailedEvaluator and state transition to FAILED
+ * EvaluatorException will trigger is FailedEvaluator and state transition to FAILED.
*
* @param exception on the EvaluatorRuntime
*/
@@ -428,7 +428,7 @@ public final class EvaluatorManager implements Identifiable, AutoCloseable {
}
/**
- * Packages the ContextControlProto in an EvaluatorControlProto and forward it to the EvaluatorRuntime
+ * Packages the ContextControlProto in an EvaluatorControlProto and forward it to the EvaluatorRuntime.
*
* @param contextControlProto message contains context control info.
*/
@@ -440,7 +440,7 @@ public final class EvaluatorManager implements Identifiable, AutoCloseable {
}
/**
- * Forward the EvaluatorControlProto to the EvaluatorRuntime
+ * Forward the EvaluatorControlProto to the EvaluatorRuntime.
*
* @param evaluatorControlProto message contains evaluator control information.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManagerFactory.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManagerFactory.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManagerFactory.java
index e230b0a..3b5c67c 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManagerFactory.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManagerFactory.java
@@ -53,7 +53,7 @@ public final class EvaluatorManagerFactory {
}
/**
- * Helper method to create a new EvaluatorManager instance
+ * Helper method to create a new EvaluatorManager instance.
*
* @param id identifier of the Evaluator
* @param desc NodeDescriptor on which the Evaluator executes.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/idle/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/idle/package-info.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/idle/package-info.java
index 35dffa2..6877bd3 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/idle/package-info.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/idle/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * Contains the Driver idle handling and extension APIs
+ * Contains the Driver idle handling and extension APIs.
*/
-package org.apache.reef.runtime.common.driver.idle;
\ No newline at end of file
+package org.apache.reef.runtime.common.driver.idle;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java
index 0ddaafb..550b8a1 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java
@@ -24,7 +24,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation;
import org.apache.reef.util.Optional;
/**
- * Event from Driver Runtime -> Driver Process
+ * Event from Driver Runtime -> Driver Process.
* Description of a node in the cluster
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java
index 1c17b15..ea68d44 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java
@@ -25,7 +25,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation;
import org.apache.reef.util.Optional;
/**
- * Event from Driver Runtime -> Driver Process
+ * Event from Driver Runtime -> Driver Process.
* Status of a resource in the cluster
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusHandler.java
index 6d31824..91e1aef 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusHandler.java
@@ -44,7 +44,7 @@ public final class ResourceStatusHandler implements EventHandler<ResourceStatusE
}
/**
- * This resource status message comes from the ResourceManager layer; telling me what it thinks
+ * This resource status message comes from the ResourceManager layer; telling me what it thinks.
* about the state of the resource executing an Evaluator; This method simply passes the message
* off to the referenced EvaluatorManager
*
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java
index bca7354..efe5548 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java
@@ -27,7 +27,7 @@ import org.apache.reef.util.Optional;
import java.util.List;
/**
- * Event from Driver Runtime -> Driver Process
+ * Event from Driver Runtime -> Driver Process.
* A status update from the Driver Runtime to the Driver Process
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEventImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEventImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEventImpl.java
index 5d8060d..db163bc 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEventImpl.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEventImpl.java
@@ -100,7 +100,7 @@ public final class RuntimeStatusEventImpl implements RuntimeStatusEvent {
}
/**
- * Add an entry to containerAllocationList
+ * Add an entry to containerAllocationList.
* @see RuntimeStatusEvent#getContainerAllocationList()
*/
public Builder addContainerAllocation(final String containerAllocation) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/DriverConnection.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/DriverConnection.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/DriverConnection.java
index a3ce3f3..d5e5d80 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/DriverConnection.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/DriverConnection.java
@@ -19,7 +19,7 @@
package org.apache.reef.runtime.common.evaluator;
/**
- * Interface used for reconnecting to driver after driver restart
+ * Interface used for reconnecting to driver after driver restart.
*/
public interface DriverConnection extends AutoCloseable {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextLifeCycle.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextLifeCycle.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextLifeCycle.java
index 586ef89..939d5ca 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextLifeCycle.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextLifeCycle.java
@@ -76,7 +76,7 @@ final class ContextLifeCycle {
}
/**
- * Deliver the driver message to the context message handler
+ * Deliver the driver message to the context message handler.
*
* @param message sent by the driver
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java
index e15e1f8..0276625 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java
@@ -325,7 +325,7 @@ public final class ContextManager implements AutoCloseable {
}
/**
- * THIS ASSUMES THAT IT IS CALLED ON A THREAD HOLDING THE LOCK ON THE HeartBeatManager
+ * THIS ASSUMES THAT IT IS CALLED ON A THREAD HOLDING THE LOCK ON THE HeartBeatManager.
*/
private void handleTaskException(final TaskClientCodeException e) {
@@ -347,7 +347,7 @@ public final class ContextManager implements AutoCloseable {
}
/**
- * THIS ASSUMES THAT IT IS CALLED ON A THREAD HOLDING THE LOCK ON THE HeartBeatManager
+ * THIS ASSUMES THAT IT IS CALLED ON A THREAD HOLDING THE LOCK ON THE HeartBeatManager.
*/
private void handleContextException(final ContextClientCodeException e) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStartHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStartHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStartHandler.java
index a3fbce5..141d927 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStartHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStartHandler.java
@@ -27,7 +27,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Default handler for ContextStart
+ * Default handler for ContextStart.
*/
@EvaluatorSide
public final class DefaultContextStartHandler implements EventHandler<ContextStart> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStopHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStopHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStopHandler.java
index 4031a4b..4d71874 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStopHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/defaults/DefaultContextStopHandler.java
@@ -27,7 +27,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Default event handler for ContextStop
+ * Default event handler for ContextStop.
*/
@EvaluatorSide
public final class DefaultContextStopHandler implements EventHandler<ContextStop> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/RootServiceConfiguration.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/RootServiceConfiguration.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/RootServiceConfiguration.java
index aabc326..9c64614 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/RootServiceConfiguration.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/RootServiceConfiguration.java
@@ -22,7 +22,7 @@ import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
/**
- * The service configuration for the root context
+ * The service configuration for the root context.
*/
@NamedParameter(doc = "The service configuration for the root context")
public final class RootServiceConfiguration implements Name<String> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskRuntime.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskRuntime.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskRuntime.java
index ea8dd27..341252c 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskRuntime.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskRuntime.java
@@ -150,7 +150,7 @@ public final class TaskRuntime implements Runnable {
}
/**
- * Called by heartbeat manager
+ * Called by heartbeat manager.
*
* @return current TaskStatusProto
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStartImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStartImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStartImpl.java
index 5bd598e..826fe80 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStartImpl.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStartImpl.java
@@ -25,7 +25,7 @@ import org.apache.reef.task.events.TaskStart;
import javax.inject.Inject;
/**
- * Injectable implementation of TaskStart
+ * Injectable implementation of TaskStart.
*/
final class TaskStartImpl implements TaskStart {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStopImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStopImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStopImpl.java
index 521d859..2cd0d73 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStopImpl.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/TaskStopImpl.java
@@ -25,7 +25,7 @@ import org.apache.reef.task.events.TaskStop;
import javax.inject.Inject;
/**
- * Injectable implementation of TaskStop
+ * Injectable implementation of TaskStop.
*/
final class TaskStopImpl implements TaskStop {
private final String id;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java
index 6920f82..d23f085 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java
@@ -25,7 +25,7 @@ import org.apache.reef.wake.EventHandler;
import javax.inject.Inject;
/**
- * Default implementation for EventHandler<CloseEvent>
+ * Default implementation for EventHandler<CloseEvent>.
*/
@Private
public final class DefaultCloseHandler implements EventHandler<CloseEvent> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java
index f1b4f34..33e65fc 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java
@@ -25,7 +25,7 @@ import org.apache.reef.wake.EventHandler;
import javax.inject.Inject;
/**
- * A default implementation of EventHandler<DriverMessage>
+ * A default implementation of EventHandler<DriverMessage>.
*/
@Private
public final class DefaultDriverMessageHandler implements EventHandler<DriverMessage> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultSuspendHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultSuspendHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultSuspendHandler.java
index 3b485c6..d8a5604 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultSuspendHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultSuspendHandler.java
@@ -25,7 +25,7 @@ import org.apache.reef.wake.EventHandler;
import javax.inject.Inject;
/**
- * Default handler for SuspendEvent
+ * Default handler for SuspendEvent.
*/
@Private
public final class DefaultSuspendHandler implements EventHandler<SuspendEvent> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCallFailure.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCallFailure.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCallFailure.java
index 9827a01..2d032fd 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCallFailure.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCallFailure.java
@@ -22,7 +22,7 @@ import org.apache.reef.annotations.audience.EvaluatorSide;
import org.apache.reef.annotations.audience.Private;
/**
- * Thrown when a Task.call() throws an exception
+ * Thrown when a Task.call() throws an exception.
*/
@EvaluatorSide
@Private
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCloseHandlerFailure.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCloseHandlerFailure.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCloseHandlerFailure.java
index bb18044..dc227f2 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCloseHandlerFailure.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskCloseHandlerFailure.java
@@ -22,7 +22,7 @@ import org.apache.reef.annotations.audience.EvaluatorSide;
import org.apache.reef.annotations.audience.Private;
/**
- * Thrown when a Task Close Handler throws an exception
+ * Thrown when a Task Close Handler throws an exception.
*/
@EvaluatorSide
@Private
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskMessageHandlerFailure.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskMessageHandlerFailure.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskMessageHandlerFailure.java
index 8ccf1d1..cc3639c 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskMessageHandlerFailure.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskMessageHandlerFailure.java
@@ -22,7 +22,7 @@ import org.apache.reef.annotations.audience.EvaluatorSide;
import org.apache.reef.annotations.audience.Private;
/**
- * Thrown when a Task Message Handler throws an exception
+ * Thrown when a Task Message Handler throws an exception.
*/
@EvaluatorSide
@Private
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStartHandlerFailure.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStartHandlerFailure.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStartHandlerFailure.java
index 24dcb35..8e0da64 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStartHandlerFailure.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStartHandlerFailure.java
@@ -24,7 +24,7 @@ import org.apache.reef.task.events.TaskStart;
import org.apache.reef.wake.EventHandler;
/**
- * Thrown when a TastStart handler throws an exception
+ * Thrown when a TastStart handler throws an exception.
*/
@EvaluatorSide
@Private
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStopHandlerFailure.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStopHandlerFailure.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStopHandlerFailure.java
index 05d77bc..0ba5983 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStopHandlerFailure.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskStopHandlerFailure.java
@@ -24,7 +24,7 @@ import org.apache.reef.task.events.TaskStop;
import org.apache.reef.wake.EventHandler;
/**
- * Thrown when a TaskStop handler throws an exception
+ * Thrown when a TaskStop handler throws an exception.
*/
@EvaluatorSide
@Private
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskSuspendHandlerFailure.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskSuspendHandlerFailure.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskSuspendHandlerFailure.java
index 31b275e..4b143f0 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskSuspendHandlerFailure.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/exceptions/TaskSuspendHandlerFailure.java
@@ -22,7 +22,7 @@ import org.apache.reef.annotations.audience.EvaluatorSide;
import org.apache.reef.annotations.audience.Private;
/**
- * Thrown when a Task Suspend Handler throws an exception
+ * Thrown when a Task Suspend Handler throws an exception.
*/
@EvaluatorSide
@Private
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileResource.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileResource.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileResource.java
index e088afd..873e182 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileResource.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileResource.java
@@ -22,7 +22,7 @@ import org.apache.reef.annotations.audience.RuntimeAuthor;
import org.apache.reef.tang.annotations.DefaultImplementation;
/**
- * A File Resource with a FileType for use by Runtimes
+ * A File Resource with a FileType for use by Runtimes.
*/
@RuntimeAuthor
@DefaultImplementation(FileResourceImpl.class)
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileType.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileType.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileType.java
index 1b729ad..7bb3e0b 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileType.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/FileType.java
@@ -21,7 +21,7 @@ package org.apache.reef.runtime.common.files;
import org.apache.reef.annotations.audience.RuntimeAuthor;
/**
- * Type of a File Resource used by Runtimes
+ * Type of a File Resource used by Runtimes.
*/
@RuntimeAuthor
public enum FileType {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java
index 562ca7b..b816105 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java
@@ -67,7 +67,7 @@ public final class REEFFileNames {
}
/**
- * reef/local/BRIDGE_DLL_NAME
+ * reef/local/BRIDGE_DLL_NAME.
*
* @return the File pointing to the DLL containing the DLL for the bridge.
*/
@@ -84,7 +84,7 @@ public final class REEFFileNames {
/**
- * The name of the REEF folder inside of the working directory of an Evaluator or Driver
+ * The name of the REEF folder inside of the working directory of an Evaluator or Driver.
*/
public String getREEFFolderName() {
return REEF_BASE_FOLDER;
@@ -143,7 +143,7 @@ public final class REEFFileNames {
/**
- * The name under which the driver configuration will be stored in REEF_BASE_FOLDER/LOCAL_FOLDER
+ * The name under which the driver configuration will be stored in REEF_BASE_FOLDER/LOCAL_FOLDER.
*/
public String getDriverConfigurationName() {
return DRIVER_CONFIGURATION_NAME;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/UnixJVMPathProvider.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/UnixJVMPathProvider.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/UnixJVMPathProvider.java
index d18c8e9..9be2701 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/UnixJVMPathProvider.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/UnixJVMPathProvider.java
@@ -21,7 +21,7 @@ package org.apache.reef.runtime.common.files;
import javax.inject.Inject;
/**
- * Supplies the java binary's path for Unix systems based on JAVA_HOME
+ * Supplies the java binary's path for Unix systems based on JAVA_HOME.
*/
public final class UnixJVMPathProvider implements RuntimePathProvider {
@Inject
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/ProcessType.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/ProcessType.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/ProcessType.java
index 286174e..dec0cea 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/ProcessType.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/ProcessType.java
@@ -19,7 +19,7 @@
package org.apache.reef.runtime.common.launch;
/**
- * The type of a process to be launched by the Runtime
+ * The type of a process to be launched by the Runtime.
*/
public enum ProcessType {
JVM,
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/parameters/ClockConfigurationPath.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/parameters/ClockConfigurationPath.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/parameters/ClockConfigurationPath.java
index 3715774..88551a3 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/parameters/ClockConfigurationPath.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/parameters/ClockConfigurationPath.java
@@ -22,7 +22,7 @@ import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
/**
- * The path to the clock configuration
+ * The path to the clock configuration.
*/
@NamedParameter(doc = "The path to process configuration.", short_name = ClockConfigurationPath.SHORT_NAME)
public final class ClockConfigurationPath implements Name<String> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java
index 68cd7ce..599dee1 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java
@@ -19,11 +19,11 @@
package org.apache.reef.util;
/**
- * Utilities for creating Builders
+ * Utilities for creating Builders.
*/
public final class BuilderUtils {
/**
- * Throws a runtime exception if the parameter is null
+ * Throws a runtime exception if the parameter is null.
*/
public static <T> T notNull(final T parameter) {
if (parameter == null) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/CommandUtils.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/CommandUtils.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/CommandUtils.java
index 146a161..053918a 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/CommandUtils.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/CommandUtils.java
@@ -25,7 +25,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * run given command and return the result as string
+ * run given command and return the result as string.
*/
final public class CommandUtils {
/**
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/DeadlockInfo.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/DeadlockInfo.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/DeadlockInfo.java
index 24eae01..d4d1c0e 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/DeadlockInfo.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/DeadlockInfo.java
@@ -55,7 +55,7 @@ final class DeadlockInfo {
}
/**
- * Get a list of monitor locks that were acquired by this thread at this stack element
+ * Get a list of monitor locks that were acquired by this thread at this stack element.
* @param threadInfo The thread that created the stack element
* @param stackTraceElement The stack element
* @return List of monitor locks that were acquired by this thread at this stack element or an empty list if none were acquired
@@ -75,7 +75,7 @@ final class DeadlockInfo {
}
/**
- * Get a string identifying the lock that this thread is waiting on
+ * Get a string identifying the lock that this thread is waiting on.
* @param threadInfo
* @return A string identifying the lock that this thread is waiting on, or null if the thread is not waiting on a lock
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java
index 735f053..258ff57 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java
@@ -19,7 +19,7 @@
package org.apache.reef.util;
/**
- * Utility class to deal with Exceptions
+ * Utility class to deal with Exceptions.
*/
public final class Exceptions {
private Exceptions() {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/OSUtils.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/OSUtils.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/OSUtils.java
index b6cd16e..d568ed7 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/OSUtils.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/OSUtils.java
@@ -89,7 +89,7 @@ public final class OSUtils {
}
/**
- * Formats the given variable for expansion by Windows (<code>%VARIABE%</code>) or Linux (<code>$VARIABLE</code>)
+ * Formats the given variable for expansion by Windows (<code>%VARIABE%</code>) or Linux (<code>$VARIABLE</code>).
*
* @param variableName
* @return
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/REEFVersion.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/REEFVersion.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/REEFVersion.java
index 1b74e7f..d879479 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/REEFVersion.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/REEFVersion.java
@@ -26,7 +26,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Version information, retrieved from the pom (via a properties file reference)
+ * Version information, retrieved from the pom (via a properties file reference).
*/
public final class REEFVersion {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/ThreadLogger.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/ThreadLogger.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/ThreadLogger.java
index dd54bf9..5a6b62f 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/ThreadLogger.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/ThreadLogger.java
@@ -38,7 +38,7 @@ public final class ThreadLogger {
}
/**
- * Same as <code>logThreads(logger, level, prefix, "\n\t", "\n\t\t")</code>
+ * Same as <code>logThreads(logger, level, prefix, "\n\t", "\n\t\t")</code>.
*/
public static void logThreads(final Logger logger, final Level level, final String prefix) {
logThreads(logger, level, prefix, "\n\t", "\n\t\t");
@@ -80,14 +80,14 @@ public final class ThreadLogger {
}
/**
- * Same as <code>getFormattedThreadList(prefix, "\n\t", "\n\t\t")</code>
+ * Same as <code>getFormattedThreadList(prefix, "\n\t", "\n\t\t")</code>.
*/
public static String getFormattedThreadList(final String prefix) {
return getFormattedThreadList(prefix, "\n\t", "\n\t\t");
}
/**
- * Produces a String representation of threads that are deadlocked, including lock information
+ * Produces a String representation of threads that are deadlocked, including lock information.
* @param prefix The prefix of the string returned.
* @param threadPrefix Printed before each thread, e.g. "\n\t" to create an indented list.
* @param stackElementPrefix Printed before each stack trace element, e.g. "\n\t\t" to create an indented list.
@@ -125,7 +125,7 @@ public final class ThreadLogger {
}
/**
- * Same as <code>getFormattedDeadlockInfo(prefix, "\n\t", "\n\t\t")</code>
+ * Same as <code>getFormattedDeadlockInfo(prefix, "\n\t", "\n\t\t")</code>.
*/
public static String getFormattedDeadlockInfo(final String prefix) {
return getFormattedDeadlockInfo(prefix, "\n\t", "\n\t\t");
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogLevelName.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogLevelName.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogLevelName.java
index a25a578..9b6b5ae 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogLevelName.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogLevelName.java
@@ -23,7 +23,7 @@ import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
/**
- * Name of a log Level as a string such as "INFO", "FINE"
+ * Name of a log Level as a string such as "INFO", "FINE".
*/
@NamedParameter(default_value = "FINE")
public class LogLevelName implements Name<String> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogParser.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogParser.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogParser.java
index 4f6ed04..adc5cb2 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogParser.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LogParser.java
@@ -25,7 +25,7 @@ import java.io.IOException;
import java.util.ArrayList;
/**
- * Parse logs for reporting
+ * Parse logs for reporting.
*/
public class LogParser {
@@ -57,7 +57,7 @@ public class LogParser {
}
/**
- * Get lines from a given file with a specified filter, trim the line by removing strings before removeBeforeToken and after removeAfterToken
+ * Get lines from a given file with a specified filter, trim the line by removing strings before removeBeforeToken and after removeAfterToken.
* @param fileName
* @param filter
* @return
@@ -99,7 +99,7 @@ public class LogParser {
}
/**
- * get lines from given file with specified filter
+ * get lines from given file with specified filter.
* @param fileName
* @param filter
* @return
@@ -110,7 +110,7 @@ public class LogParser {
}
/**
- * filter array list of lines and get the last portion of the line separated by the token, like ":::"
+ * filter array list of lines and get the last portion of the line separated by the token, like ":::".
* @param original
* @param filter
* @return
@@ -161,4 +161,4 @@ public class LogParser {
}
return mergeStage;
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScope.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScope.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScope.java
index 56cb779..95fff56 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScope.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScope.java
@@ -20,10 +20,10 @@
package org.apache.reef.util.logging;
/**
- * Log time elapsed for a scope
+ * Log time elapsed for a scope.
*/
public interface LoggingScope extends AutoCloseable {
@Override
public void close();
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeFactory.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeFactory.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeFactory.java
index 6f4bc54..c2bc06b 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeFactory.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeFactory.java
@@ -29,7 +29,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Create Logging scope objects
+ * Create Logging scope objects.
*/
public class LoggingScopeFactory {
@@ -68,7 +68,7 @@ public class LoggingScopeFactory {
private final Level logLevel;
/**
- * User can inject a LoggingScopeFactory with injected log level as a string
+ * User can inject a LoggingScopeFactory with injected log level as a string.
*/
@Inject
private LoggingScopeFactory(@Parameter(LogLevelName.class) final String logLevelName) {
@@ -76,7 +76,7 @@ public class LoggingScopeFactory {
}
/**
- * Get a new instance of LoggingScope with specified log level
+ * Get a new instance of LoggingScope with specified log level.
* @param logLevel
* @param msg
* @return
@@ -86,7 +86,7 @@ public class LoggingScopeFactory {
}
/**
- * Get a new instance of LoggingScope with injected LoggingScopeFactory instance
+ * Get a new instance of LoggingScope with injected LoggingScopeFactory instance.
* @param msg
* @return
*/
@@ -95,7 +95,7 @@ public class LoggingScopeFactory {
}
/**
- * Get a new instance of LoggingScope with msg and params through new
+ * Get a new instance of LoggingScope with msg and params through new.
* @param msg
* @param params
* @return
@@ -131,7 +131,7 @@ public class LoggingScopeFactory {
}
/**
- * The method is to measure the time used to load global files and libraries
+ * The method is to measure the time used to load global files and libraries.
* @return
*/
public LoggingScope loadLib() {
@@ -156,7 +156,7 @@ public class LoggingScopeFactory {
}
/**
- * The method is to measure the time used to submit a Evaluator request at java side
+ * The method is to measure the time used to submit a Evaluator request at java side.
* @param evaluatorNumber
* @return
*/
@@ -165,7 +165,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time on evaluatorAllocated handler
+ * This is to measure the time on evaluatorAllocated handler.
* @param evaluatorId
* @return
*/
@@ -174,7 +174,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time to launch an evaluator
+ * This is to measure the time to launch an evaluator.
* @param evaluatorId
* @return
*/
@@ -183,7 +183,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling evaluatorCompleted handler
+ * This is to measure the time in calling evaluatorCompleted handler.
* @param evaluatorId
* @return
*/
@@ -192,7 +192,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling evaluatorFailed handler
+ * This is to measure the time in calling evaluatorFailed handler.
* @param evaluatorId
* @return
*/
@@ -201,7 +201,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling activeContext handler
+ * This is to measure the time in calling activeContext handler.
* @param contextId
* @return
*/
@@ -210,7 +210,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling closedContext handler
+ * This is to measure the time in calling closedContext handler.
* @param contextId
* @return
*/
@@ -219,7 +219,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling runningTaskHandler
+ * This is to measure the time in calling runningTaskHandler.
* @param taskId
* @return
*/
@@ -228,7 +228,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling taskCompletedHandler
+ * This is to measure the time in calling taskCompletedHandler.
* @param taskId
* @return
*/
@@ -237,7 +237,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling taskSuspendedHandler
+ * This is to measure the time in calling taskSuspendedHandler.
* @param taskId
* @return
*/
@@ -246,7 +246,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling taskMessageReceivedHandler
+ * This is to measure the time in calling taskMessageReceivedHandler.
* @param msg
* @return
*/
@@ -255,7 +255,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling contextMessageReceivedHandler
+ * This is to measure the time in calling contextMessageReceivedHandler.
* @param msg
* @return
*/
@@ -264,7 +264,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling driverRestartHandler
+ * This is to measure the time in calling driverRestartHandler.
* @param startTime
* @return
*/
@@ -273,7 +273,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling driverRestartCompletedHandler
+ * This is to measure the time in calling driverRestartCompletedHandler.
* @param timeStamp
* @return
*/
@@ -282,7 +282,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling driverRestartRunningTaskHandler
+ * This is to measure the time in calling driverRestartRunningTaskHandler.
* @param taskId
* @return
*/
@@ -291,7 +291,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in calling driverRestartActiveContextReceivedHandler
+ * This is to measure the time in calling driverRestartActiveContextReceivedHandler.
* @param contextId
* @return
*/
@@ -300,7 +300,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time in handling a http request
+ * This is to measure the time in handling a http request.
* @param uri
* @return
*/
@@ -309,7 +309,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time used to create HttpServer
+ * This is to measure the time used to create HttpServer.
* @return
*/
public LoggingScope httpServer() {
@@ -317,7 +317,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time to submit a driver
+ * This is to measure the time to submit a driver.
* @param submitDriver
* @return
*/
@@ -326,7 +326,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time to call Reef.Submit
+ * This is to measure the time to call Reef.Submit.
* @return
*/
public LoggingScope reefSubmit() {
@@ -334,7 +334,7 @@ public class LoggingScopeFactory {
}
/**
- * This is to measure the time for a job submission
+ * This is to measure the time for a job submission.
* @return
*/
public LoggingScope localJobSubmission() {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeImpl.java
index 8475532..fa241b0 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeImpl.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingScopeImpl.java
@@ -26,7 +26,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Log time and duration for a scope
+ * Log time and duration for a scope.
*/
public class LoggingScopeImpl implements LoggingScope {
public static final String TOKEN = ":::";
@@ -91,7 +91,7 @@ public class LoggingScopeImpl implements LoggingScope {
}
/**
- * log massage
+ * log massage.
* @param msg
*/
private void log(final String msg) {
@@ -101,4 +101,4 @@ public class LoggingScopeImpl implements LoggingScope {
logger.log(logLevel, msg);
}
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingSetup.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingSetup.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingSetup.java
index 7d683f0..0c6d0e0 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingSetup.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/LoggingSetup.java
@@ -19,7 +19,7 @@
package org.apache.reef.util.logging;
/**
- * Configure Commons Logging
+ * Configure Commons Logging.
*/
public final class LoggingSetup {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java b/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java
index 0578635..94f8141 100644
--- a/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java
+++ b/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java
@@ -46,7 +46,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * The Driver code for the Hello REEF Application
+ * The Driver code for the Hello REEF Application.
*/
@Unit
public final class HelloDriver {
@@ -167,7 +167,7 @@ public final class HelloDriver {
}
/**
- * Handles AllocatedEvaluator: Submit an empty context and the HelloTask
+ * Handles AllocatedEvaluator: Submit an empty context and the HelloTask.
*/
final class EvaluatorAllocatedHandler implements EventHandler<AllocatedEvaluator> {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/HelloHDInsight.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/HelloHDInsight.java b/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/HelloHDInsight.java
index 2eacd7b..177783c 100644
--- a/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/HelloHDInsight.java
+++ b/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/HelloHDInsight.java
@@ -24,7 +24,7 @@ import org.apache.reef.tang.exceptions.InjectionException;
import java.io.IOException;
/**
- * HelloREEF running on HDInsight
+ * HelloREEF running on HDInsight.
*/
public class HelloHDInsight {
public static void main(final String[] args) throws InjectionException, IOException {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java
index e1ccbcc..4001ad7 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java
@@ -43,7 +43,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Client for the data loading demo app
+ * Client for the data loading demo app.
*/
@ClientSide
public class DataLoadingREEF {
@@ -51,7 +51,7 @@ public class DataLoadingREEF {
private static final Logger LOG = Logger.getLogger(DataLoadingREEF.class.getName());
/**
- * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently
+ * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently.
*/
private static final int MAX_NUMBER_OF_EVALUATORS = 16;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java
index 84865e8..ad96437 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java
@@ -39,7 +39,7 @@ import org.apache.reef.util.EnvironmentUtils;
import javax.inject.Inject;
/**
- * A client to submit BGD Jobs
+ * A client to submit BGD Jobs.
*/
public class BGDClient {
private final String input;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/SVMLightParser.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/SVMLightParser.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/SVMLightParser.java
index 5f64606..0105b20 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/SVMLightParser.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/SVMLightParser.java
@@ -32,7 +32,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * A Parser for SVMLight records
+ * A Parser for SVMLight records.
*/
public class SVMLightParser implements Parser<String> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Lambda.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Lambda.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Lambda.java
index c278ca9..3467561 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Lambda.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Lambda.java
@@ -22,7 +22,7 @@ import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
/**
- * The regularization constant
+ * The regularization constant.
*/
@NamedParameter(doc = "The regularization constant", short_name = "lambda", default_value = "1e-4")
public final class Lambda implements Name<Double> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java
index 5505859..d597697 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java
@@ -134,7 +134,7 @@ public class BroadcastDriver {
}
/**
- * Handles AllocatedEvaluator: Submits a context with an id
+ * Handles AllocatedEvaluator: Submits a context with an id.
*/
final class EvaluatorAllocatedHandler implements EventHandler<AllocatedEvaluator> {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java
index 839bea4..3abaa00 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java
@@ -85,7 +85,7 @@ public class BroadcastREEF {
}
/**
- * copy the parameters from the command line required for the Client configuration
+ * copy the parameters from the command line required for the Client configuration.
*/
private static void storeCommandLineArgs(
final Configuration commandLineConf) throws InjectionException {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractImmutableVector.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractImmutableVector.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractImmutableVector.java
index 9fa8498..d4dec66 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractImmutableVector.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractImmutableVector.java
@@ -25,7 +25,7 @@ import java.util.Formatter;
import java.util.Locale;
/**
- * Base class for implementing ImmutableVector
+ * Base class for implementing ImmutableVector.
*/
abstract class AbstractImmutableVector implements ImmutableVector {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/DenseVector.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/DenseVector.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/DenseVector.java
index bc46521..1f785b4 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/DenseVector.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/DenseVector.java
@@ -23,7 +23,7 @@ import java.util.Arrays;
import java.util.Random;
/**
- * A dense {@link Vector} implementation backed by a double[]
+ * A dense {@link Vector} implementation backed by a double[].
*/
public class DenseVector extends AbstractVector implements Serializable {
@@ -31,7 +31,7 @@ public class DenseVector extends AbstractVector implements Serializable {
private final double[] values;
/**
- * Creates a dense vector of the given size
+ * Creates a dense vector of the given size.
*/
public DenseVector(final int size) {
this(new double[size]);
@@ -79,7 +79,7 @@ public class DenseVector extends AbstractVector implements Serializable {
}
/**
- * Creates a random Vector of size 'size' where each element is individually
+ * Creates a random Vector of size 'size' where each element is individually.
* drawn from Math.random()
*
* @return a random Vector of the given size where each element is
@@ -90,7 +90,7 @@ public class DenseVector extends AbstractVector implements Serializable {
}
/**
- * Creates a random Vector of size 'size' where each element is individually
+ * Creates a random Vector of size 'size' where each element is individually.
* drawn from Math.random()
*
* @param random the random number generator to use.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/ImmutableVector.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/ImmutableVector.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/ImmutableVector.java
index cfd2e8d..36961c7 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/ImmutableVector.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/ImmutableVector.java
@@ -26,7 +26,7 @@ import org.apache.reef.io.Tuple;
*/
public interface ImmutableVector {
/**
- * Access the value of the Vector at dimension i
+ * Access the value of the Vector at dimension i.
*
* @param i index
* @return the value at index i
@@ -34,7 +34,7 @@ public interface ImmutableVector {
double get(int i);
/**
- * The size (dimensionality) of the Vector
+ * The size (dimensionality) of the Vector.
*
* @return the size of the Vector.
*/
@@ -70,7 +70,7 @@ public interface ImmutableVector {
double norm2Sqr();
/**
- * Computes the min of all entries in the Vector
+ * Computes the min of all entries in the Vector.
*
* @return the min of all entries in this Vector
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Vector.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Vector.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Vector.java
index 021a666..921834a 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Vector.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Vector.java
@@ -26,7 +26,7 @@ import java.io.Serializable;
public interface Vector extends ImmutableVector, Serializable {
/**
- * Set dimension i of the Vector to value v
+ * Set dimension i of the Vector to value v.
*
* @param i the index
* @param v value
@@ -62,7 +62,7 @@ public interface Vector extends ImmutableVector, Serializable {
public void normalize();
/**
- * Create a new instance of the current type
+ * Create a new instance of the current type.
* with elements being zero
*
* @return zero vector of current dimensionality
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/VectorCodec.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/VectorCodec.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/VectorCodec.java
index e7ad7e9..b530d6b 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/VectorCodec.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/VectorCodec.java
@@ -24,13 +24,13 @@ import javax.inject.Inject;
import java.io.*;
/**
- * Codec for the Vector type Uses Data*Stream
+ * Codec for the Vector type Uses Data*Stream.
*
* @author shravan
*/
public class VectorCodec implements Codec<Vector> {
/**
- * This class is instantiated by TANG
+ * This class is instantiated by TANG.
*/
@Inject
public VectorCodec() {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloDriver.java
index 8344a44..f8043ee 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloDriver.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloDriver.java
@@ -32,7 +32,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * The Driver code for the Hello REEF Application
+ * The Driver code for the Hello REEF Application.
*/
@Unit
public final class HelloDriver {
@@ -68,7 +68,7 @@ public final class HelloDriver {
}
/**
- * Handles AllocatedEvaluator: Submit the HelloTask
+ * Handles AllocatedEvaluator: Submit the HelloTask.
*/
public final class EvaluatorAllocatedHandler implements EventHandler<AllocatedEvaluator> {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEF.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEF.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEF.java
index 6a23274..6849b38 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEF.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEF.java
@@ -37,7 +37,7 @@ public final class HelloREEF {
private static final Logger LOG = Logger.getLogger(HelloREEF.class.getName());
/**
- * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently
+ * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently.
*/
private static final int MAX_NUMBER_OF_EVALUATORS = 2;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttp.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttp.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttp.java
index 086943d..39b746d 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttp.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttp.java
@@ -39,7 +39,7 @@ import java.util.logging.Logger;
*/
public final class HelloREEFHttp {
/**
- * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently
+ * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently.
*/
private static final int MAX_NUMBER_OF_EVALUATORS = 3;
@@ -88,7 +88,7 @@ public final class HelloREEFHttp {
}
/**
- * Run Hello Reef with merged configuration
+ * Run Hello Reef with merged configuration.
*
* @param runtimeConf
* @param timeOut
@@ -103,7 +103,7 @@ public final class HelloREEFHttp {
}
/**
- * main program
+ * main program.
*
* @param args
* @throws InjectionException
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttpYarn.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttpYarn.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttpYarn.java
index f3b05de..67a83e8 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttpYarn.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HelloREEFHttpYarn.java
@@ -29,7 +29,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * HelloREEFHttp for running on Yarn
+ * HelloREEFHttp for running on Yarn.
*/
public class HelloREEFHttpYarn {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpServerShellCmdtHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpServerShellCmdtHandler.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpServerShellCmdtHandler.java
index ff22d81..39ed669 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpServerShellCmdtHandler.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpServerShellCmdtHandler.java
@@ -36,7 +36,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Http Event handler for Shell Command
+ * Http Event handler for Shell Command.
*/
@Unit
class HttpServerShellCmdtHandler implements HttpHandler {
@@ -50,17 +50,17 @@ class HttpServerShellCmdtHandler implements HttpHandler {
private static final int WAIT_TIME = 50;
/**
- * ClientMessageHandler
+ * ClientMessageHandler.
*/
private final InjectionFuture<HttpShellJobDriver.ClientMessageHandler> messageHandler;
/**
- * uri specification
+ * uri specification.
*/
private String uriSpecification = "Command";
/**
- * output for command
+ * output for command.
*/
private String cmdOutput = null;
@@ -73,7 +73,7 @@ class HttpServerShellCmdtHandler implements HttpHandler {
}
/**
- * returns URI specification for the handler
+ * returns URI specification for the handler.
*
* @return
*/
@@ -83,7 +83,7 @@ class HttpServerShellCmdtHandler implements HttpHandler {
}
/**
- * set URI specification
+ * set URI specification.
*
* @param s
*/
@@ -92,7 +92,7 @@ class HttpServerShellCmdtHandler implements HttpHandler {
}
/**
- * it is called when receiving a http request
+ * it is called when receiving a http request.
*
* @param parsedHttpRequest
* @param response
@@ -132,7 +132,7 @@ class HttpServerShellCmdtHandler implements HttpHandler {
}
/**
- * called after shell command is completed
+ * called after shell command is completed.
*
* @param message
*/
@@ -157,7 +157,7 @@ class HttpServerShellCmdtHandler implements HttpHandler {
}
/**
- * Handler for client to call back
+ * Handler for client to call back.
*/
final class ClientCallBackHandler implements EventHandler<byte[]> {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java
index 44b62a3..677d78f 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java
@@ -48,7 +48,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * The Driver code for the Hello REEF Http Distributed Shell Application
+ * The Driver code for the Hello REEF Http Distributed Shell Application.
*/
@Unit
public final class HttpShellJobDriver {
@@ -60,7 +60,7 @@ public final class HttpShellJobDriver {
public static final ObjectSerializableCodec<String> CODEC = new ObjectSerializableCodec<>();
private static final Logger LOG = Logger.getLogger(HttpShellJobDriver.class.getName());
/**
- * Evaluator Requester
+ * Evaluator Requester.
*/
private final EvaluatorRequestor evaluatorRequestor;
/**
@@ -89,12 +89,12 @@ public final class HttpShellJobDriver {
*/
private int expectCount = 0;
/**
- * Callback handler for http return message
+ * Callback handler for http return message.
*/
private HttpServerShellCmdtHandler.ClientCallBackHandler httpCallbackHandler;
/**
- * Job Driver Constructor
+ * Job Driver Constructor.
*
* @param requestor
* @param clientCallBackHandler
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/ShellTask.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/ShellTask.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/ShellTask.java
index 0ea7b99..78f1a2b 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/ShellTask.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/ShellTask.java
@@ -43,7 +43,7 @@ public class ShellTask implements Task {
private final String command;
/**
- * Object Serializable Codec
+ * Object Serializable Codec.
*/
private static final ObjectSerializableCodec<String> CODEC = new ObjectSerializableCodec<>();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/pool/Launch.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/pool/Launch.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/pool/Launch.java
index 6c832c0..f9f0cbc 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/pool/Launch.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/pool/Launch.java
@@ -44,11 +44,11 @@ import java.util.logging.Logger;
public final class Launch {
/**
- * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently
+ * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently.
*/
private static final int MAX_NUMBER_OF_EVALUATORS = 4;
/**
- * Standard Java logger
+ * Standard Java logger.
*/
private static final Logger LOG = Logger.getLogger(Launch.class.getName());