http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/Scheduler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/Scheduler.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/Scheduler.java index 544f333..0bcbba5 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/Scheduler.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/Scheduler.java @@ -106,7 +106,7 @@ final class Scheduler { } /** - * Clear the pending list + * Clear the pending list. */ public synchronized SchedulerResponse clear() { final int count = taskQueue.size();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerHttpHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerHttpHandler.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerHttpHandler.java index 071057e..754852d 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerHttpHandler.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerHttpHandler.java @@ -30,7 +30,7 @@ import java.util.List; import java.util.Map; /** - * Receive HttpRequest so that it can handle the command list + * Receive HttpRequest so that it can handle the command list. */ final class SchedulerHttpHandler implements HttpHandler { final InjectionFuture<SchedulerDriver> schedulerDriver; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEF.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEF.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEF.java index 80c9096..13d678a 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEF.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEF.java @@ -39,12 +39,12 @@ import java.io.IOException; */ public final class SchedulerREEF { /** - * 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; /** - * Command line parameter = true to reuse evaluators, + * Command line parameter = true to reuse evaluators,. * or false to allocate/close for each iteration */ @NamedParameter(doc = "Whether or not to reuse evaluators", @@ -100,7 +100,7 @@ public final class SchedulerREEF { } /** - * 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/scheduler/SchedulerREEFYarn.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEFYarn.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEFYarn.java index c42cba5..9dbd56d 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEFYarn.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerREEFYarn.java @@ -32,7 +32,7 @@ import static org.apache.reef.examples.scheduler.SchedulerREEF.runTaskScheduler; */ public final class SchedulerREEFYarn { /** - * Launch the scheduler with YARN client configuration + * Launch the scheduler with YARN client configuration. * @param args * @throws InjectionException * @throws java.io.IOException http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerResponse.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerResponse.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerResponse.java index 50293e6..fbd0670 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerResponse.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerResponse.java @@ -44,28 +44,28 @@ final class SchedulerResponse { private static final int SC_NOT_FOUND = 404; /** - * Create a response with OK status + * Create a response with OK status. */ public static SchedulerResponse OK(final String message){ return new SchedulerResponse (SC_OK, message); } /** - * Create a response with BAD_REQUEST status + * Create a response with BAD_REQUEST status. */ public static SchedulerResponse BAD_REQUEST(final String message){ return new SchedulerResponse (SC_BAD_REQUEST, message); } /** - * Create a response with FORBIDDEN status + * Create a response with FORBIDDEN status. */ public static SchedulerResponse FORBIDDEN(final String message){ return new SchedulerResponse (SC_FORBIDDEN, message); } /** - * Create a response with NOT FOUND status + * Create a response with NOT FOUND status. */ public static SchedulerResponse NOT_FOUND(final String message){ return new SchedulerResponse (SC_NOT_FOUND, message); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/package-info.java index 728806c..b647063 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/package-info.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * Task scheduler example based on reef-webserver + * Task scheduler example based on reef-webserver. */ -package org.apache.reef.examples.scheduler; \ No newline at end of file +package org.apache.reef.examples.scheduler; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java index 3a64b9b..36e4c63 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java @@ -42,11 +42,11 @@ import java.util.logging.Logger; public final class Launch { /** - * Standard Java logger + * Standard Java logger. */ private static final Logger LOG = Logger.getLogger(Launch.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 = 4; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/ObjectWritableCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/ObjectWritableCodec.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/ObjectWritableCodec.java index 72b257a..e446fd0 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/ObjectWritableCodec.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/ObjectWritableCodec.java @@ -34,7 +34,7 @@ import java.util.logging.Logger; public class ObjectWritableCodec<T extends Writable> implements Codec<T> { /** - * Standard Java logger + * Standard Java logger. */ private static final Logger LOG = Logger.getLogger(ObjectWritableCodec.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java index 38d7542..1e044b5 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java @@ -59,7 +59,7 @@ public class SuspendDriver { private static final Logger LOG = Logger.getLogger(SuspendDriver.class.getName()); /** - * Number of evaluators to request + * Number of evaluators to request. */ private static final int NUM_EVALUATORS = 2; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorRequestSerializer.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorRequestSerializer.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorRequestSerializer.java index 2f493c6..7f46a8f 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorRequestSerializer.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorRequestSerializer.java @@ -24,7 +24,7 @@ import org.apache.reef.driver.evaluator.EvaluatorRequest; import java.io.*; /** - * Serialize and deserialize EvaluatorRequest objects + * Serialize and deserialize EvaluatorRequest objects. * Currently only supports number & memory * Does not take care of Resource Descriptor */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorToPartitionMapper.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorToPartitionMapper.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorToPartitionMapper.java index 5a5c0ff..fda95ae 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorToPartitionMapper.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/EvaluatorToPartitionMapper.java @@ -56,7 +56,7 @@ public class EvaluatorToPartitionMapper<V extends InputSplit> { private final BlockingQueue<NumberedSplit<V>> unallocatedSplits = new LinkedBlockingQueue<>(); /** - * Initializes the locations of splits mapping + * Initializes the locations of splits mapping. * * @param splits */ @@ -88,7 +88,7 @@ public class EvaluatorToPartitionMapper<V extends InputSplit> { } /** - * Get an input split to be assigned to this + * Get an input split to be assigned to this. * evaluator * <p/> * Allocates one if its not already allocated http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatExternalConstructor.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatExternalConstructor.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatExternalConstructor.java index aef6226..fee9fbf 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatExternalConstructor.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatExternalConstructor.java @@ -27,7 +27,7 @@ import javax.inject.Inject; /** - * A Tang External Constructor to inject the required + * A Tang External Constructor to inject the required. * InputFormat */ @DriverSide http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputSplitExternalConstructor.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputSplitExternalConstructor.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputSplitExternalConstructor.java index cedad2d..6a99af3 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputSplitExternalConstructor.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputSplitExternalConstructor.java @@ -29,7 +29,7 @@ import org.apache.reef.tang.annotations.Parameter; import javax.inject.Inject; /** - * A Tang external constructor to inject an InputSplit + * A Tang external constructor to inject an InputSplit. * by deserializing the serialized input split assigned * to this evaluator */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java index 6cef3b7..2ce3418 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java @@ -21,7 +21,7 @@ package org.apache.reef.io.data.loading.impl; import org.apache.hadoop.mapred.InputSplit; /** - * A tuple of an object of type E and an integer index + * A tuple of an object of type E and an integer index. * Used inside {@link EvaluatorToPartitionMapper} to * mark the partitions associated with each {@link InputSplit} * @@ -62,4 +62,4 @@ final class NumberedSplit<E> implements Comparable<NumberedSplit<E>> { else return 1; } -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/ConnectionFactory.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/ConnectionFactory.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/ConnectionFactory.java index 40b28b0..76bb6af 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/ConnectionFactory.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/ConnectionFactory.java @@ -21,14 +21,14 @@ package org.apache.reef.io.network; import org.apache.reef.wake.Identifier; /** - * Factory that creates a new connection + * Factory that creates a new connection. * * @param <T> type */ public interface ConnectionFactory<T> { /** - * Creates a new connection + * Creates a new connection. * * @param destId a destination identifier * @return a connection http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/Message.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/Message.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/Message.java index 1aaa7e0..a14b908 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/Message.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/Message.java @@ -21,28 +21,28 @@ package org.apache.reef.io.network; import org.apache.reef.wake.Identifier; /** - * Network message + * Network message. * * @param <T> */ public interface Message<T> { /** - * Gets a source identifier + * Gets a source identifier. * * @return an identifier */ Identifier getSrcId(); /** - * Gets a destination identifier + * Gets a destination identifier. * * @return an identifier */ Identifier getDestId(); /** - * Gets data + * Gets data. * * @return an iterable of data objects */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/NetworkRuntimeException.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/NetworkRuntimeException.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/NetworkRuntimeException.java index 4424e8d..cbac28f 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/NetworkRuntimeException.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/NetworkRuntimeException.java @@ -19,13 +19,13 @@ package org.apache.reef.io.network.exception; /** - * Network service resourcemanager exception + * Network service resourcemanager exception. */ public class NetworkRuntimeException extends RuntimeException { private static final long serialVersionUID = 1L; /** - * Constructs a new network resourcemanager exception with the specified detail message and cause + * Constructs a new network resourcemanager exception with the specified detail message and cause. * * @param s the detailed message * @param e the cause @@ -35,7 +35,7 @@ public class NetworkRuntimeException extends RuntimeException { } /** - * Constructs a new network resourcemanager exception with the specified detail message + * Constructs a new network resourcemanager exception with the specified detail message. * * @param s the detailed message */ @@ -44,11 +44,11 @@ public class NetworkRuntimeException extends RuntimeException { } /** - * Constructs a new network resourcemanager exception with the specified cause + * Constructs a new network resourcemanager exception with the specified cause. * * @param e the cause */ public NetworkRuntimeException(Throwable e) { super(e); } -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/ParentDeadException.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/ParentDeadException.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/ParentDeadException.java index 6e406d3..e9b4a19 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/ParentDeadException.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/ParentDeadException.java @@ -19,7 +19,7 @@ package org.apache.reef.io.network.exception; /** - * This exception is thrown by a child task + * This exception is thrown by a child task. * when it is told that its Parent died */ public class ParentDeadException extends Exception { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/GroupChanges.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/GroupChanges.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/GroupChanges.java index 1758646..28dbb9e 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/GroupChanges.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/GroupChanges.java @@ -21,7 +21,7 @@ package org.apache.reef.io.network.group.api; import org.apache.reef.annotations.audience.TaskSide; /** - * Represents the changes in Topology that happened in a communication group + * Represents the changes in Topology that happened in a communication group. * from the last time the user asked for topology changes */ @TaskSide http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java index ca486a3..7916951 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java @@ -35,7 +35,7 @@ import org.apache.reef.tang.annotations.Name; public interface CommunicationGroupDriver { /** - * Add the broadcast operator specified by the + * Add the broadcast operator specified by the. * 'spec' with name 'operatorName' into this * Communication Group * @@ -46,7 +46,7 @@ public interface CommunicationGroupDriver { public CommunicationGroupDriver addBroadcast(Class<? extends Name<String>> operatorName, BroadcastOperatorSpec spec); /** - * Add the reduce operator specified by the + * Add the reduce operator specified by the. * 'spec' with name 'operatorName' into this * Communication Group * @@ -57,7 +57,7 @@ public interface CommunicationGroupDriver { public CommunicationGroupDriver addReduce(Class<? extends Name<String>> operatorName, ReduceOperatorSpec spec); /** - * This signals to the service that no more + * This signals to the service that no more. * operator specs will be added to this communication * group and an attempt to do that will throw an * IllegalStateException http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommDriver.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommDriver.java index fc7e919..aa62673 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommDriver.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommDriver.java @@ -27,7 +27,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation; import org.apache.reef.tang.annotations.Name; /** - * The driver side interface of Group Communication + * The driver side interface of Group Communication. * which is the entry point for the service */ @DriverSide @@ -36,7 +36,7 @@ import org.apache.reef.tang.annotations.Name; public interface GroupCommDriver { /** - * Create a new communication group with the specified name + * Create a new communication group with the specified name. * and the minimum number of tasks needed in this group before * communication can start * @@ -47,7 +47,7 @@ public interface GroupCommDriver { CommunicationGroupDriver newCommunicationGroup(Class<? extends Name<String>> groupName, int numberOfTasks); /** - * Tests whether the activeContext is a context configured + * Tests whether the activeContext is a context configured. * using the Group Communication Service * * @param activeContext http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommServiceDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommServiceDriver.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommServiceDriver.java index a097075..1af2eb8 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommServiceDriver.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/GroupCommServiceDriver.java @@ -34,7 +34,7 @@ import org.apache.reef.wake.EStage; public interface GroupCommServiceDriver extends GroupCommDriver { /** - * Not user facing but used the Group Communication Service class + * Not user facing but used the Group Communication Service class. * * @return The running task stage that will handle the RunningTask * events @@ -42,7 +42,7 @@ public interface GroupCommServiceDriver extends GroupCommDriver { EStage<RunningTask> getGroupCommRunningTaskStage(); /** - * Not user facing but used the Group Communication Service class + * Not user facing but used the Group Communication Service class. * * @return The running task stage that will handle the FailedTask * events @@ -50,7 +50,7 @@ public interface GroupCommServiceDriver extends GroupCommDriver { EStage<FailedTask> getGroupCommFailedTaskStage(); /** - * Not user facing but used the Group Communication Service class + * Not user facing but used the Group Communication Service class. * * @return The running task stage that will handle the FailedEvaluator * events http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNode.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNode.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNode.java index d16d4ea..28dcf4d 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNode.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNode.java @@ -21,7 +21,7 @@ package org.apache.reef.io.network.group.api.driver; import org.apache.reef.io.network.group.impl.GroupCommunicationMessage; /** - * A node in the Topology representing a Task on the driver + * A node in the Topology representing a Task on the driver. * Impl should maintain state relating to whether task is running/dead and * status of neighboring nodes and send ctrl msgs to the tasks indicating * topology changing events @@ -63,20 +63,20 @@ public interface TaskNode { void onChildDead(String childId); /** - * Check if this node is ready for sending + * Check if this node is ready for sending. * TopologySetup */ void checkAndSendTopologySetupMessage(); /** - * Check if the neighbor node with id source + * Check if the neighbor node with id source. * is ready for sending TopologySetup * @param source */ void checkAndSendTopologySetupMessageFor(String source); /** - * reset topology setup ensures that update topology is not sent to someone + * reset topology setup ensures that update topology is not sent to someone. * who is already updating topology which is usually when they are just * (re)starting * http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java index 93955e1..a13c16d 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java @@ -41,7 +41,7 @@ public interface TaskNodeStatus { boolean isActive(String neighborId); /** - * Process the msg that was received and update + * Process the msg that was received and update. * state accordingly */ void processAcknowledgement(GroupCommunicationMessage msg); @@ -58,7 +58,7 @@ public interface TaskNodeStatus { public void expectAckFor(final Type msgType, final String srcId); /** - * Used when the task has failed to clear all + * Used when the task has failed to clear all. * the state that is associated with this task * Also should release the locks held for implementing * the convenience wait* methods @@ -66,7 +66,7 @@ public interface TaskNodeStatus { void clearStateAndReleaseLocks(); /** - * This should remove state concerning neighboring tasks + * This should remove state concerning neighboring tasks. * that have failed */ void updateFailureOf(String taskId); @@ -74,7 +74,7 @@ public interface TaskNodeStatus { void waitForTopologySetup(); /** - * Called to denote that a UpdateTopology msg will + * Called to denote that a UpdateTopology msg will. * be sent */ void updatingTopology (); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/Topology.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/Topology.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/Topology.java index b393d7f..17ebf87 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/Topology.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/Topology.java @@ -32,7 +32,7 @@ import org.apache.reef.tang.Configuration; public interface Topology { /** - * Get the version of the Task 'taskId' + * Get the version of the Task 'taskId'. * that belongs to this topology * * @param taskId @@ -41,14 +41,14 @@ public interface Topology { int getNodeVersion(String taskId); /** - * Get the id of the root task + * Get the id of the root task. * * @return */ String getRootId(); /** - * Set task with id 'senderId' as + * Set task with id 'senderId' as. * the root of this topology * * @param senderId @@ -56,7 +56,7 @@ public interface Topology { void setRootTask(String senderId); /** - * Add task with id 'taskId' to + * Add task with id 'taskId' to. * the topology * * @param taskId @@ -64,7 +64,7 @@ public interface Topology { void addTask(String taskId); /** - * Remove task with id 'taskId' from + * Remove task with id 'taskId' from. * the topology * * @param taskId @@ -72,7 +72,7 @@ public interface Topology { void removeTask(String taskId); /** - * Update state on receipt of RunningTask + * Update state on receipt of RunningTask. * event for task with id 'id' * * @param id @@ -80,7 +80,7 @@ public interface Topology { void onRunningTask(String id); /** - * Update state on receipt of FailedTask + * Update state on receipt of FailedTask. * event for task with id 'id' * * @param id @@ -88,7 +88,7 @@ public interface Topology { void onFailedTask(String id); /** - * Set operator specification of the operator + * Set operator specification of the operator. * that is the owner of this topology instance * * @param spec @@ -96,7 +96,7 @@ public interface Topology { void setOperatorSpecification(OperatorSpec spec); /** - * Get the topology portion of the Configuration + * Get the topology portion of the Configuration. * for the task 'taskId' that belongs to this * topology * @@ -106,7 +106,7 @@ public interface Topology { Configuration getTaskConfiguration(String taskId); /** - * Update state on receipt of a message + * Update state on receipt of a message. * from the tasks * * @param msg http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java index ae007ac..10bc9ce 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java @@ -45,7 +45,7 @@ public interface Broadcast { } /** - * Receivers or Non-roots + * Receivers or Non-roots. */ @DefaultImplementation(BroadcastReceiver.class) static interface Receiver<T> extends GroupCommOperator { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java index a04b02e..538ff71 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java @@ -43,7 +43,7 @@ public interface Gather { } /** - * Receiver or Root + * Receiver or Root. */ static interface Receiver<T> extends GroupCommOperator { @@ -55,7 +55,7 @@ public interface Gather { List<T> receive() throws InterruptedException, NetworkException; /** - * Receive the elements sent by the senders in specified order + * Receive the elements sent by the senders in specified order. * * @return elements sent by senders as a List in specified order */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java index b638348..3ab82cd 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java @@ -36,7 +36,7 @@ import java.util.List; public interface Reduce { /** - * Receiver or Root + * Receiver or Root. */ @DefaultImplementation(ReduceReceiver.class) static interface Receiver<T> extends GroupCommOperator { @@ -58,7 +58,7 @@ public interface Reduce { T reduce(List<? extends Identifier> order) throws InterruptedException, NetworkException; /** - * The reduce function to be applied on the set of received values + * The reduce function to be applied on the set of received values. * * @return {@link ReduceFunction} */ @@ -66,7 +66,7 @@ public interface Reduce { } /** - * Senders or non roots + * Senders or non roots. */ @DefaultImplementation(ReduceSender.class) static interface Sender<T> extends GroupCommOperator { @@ -85,7 +85,7 @@ public interface Reduce { } /** - * Interface for a Reduce Function takes in an {@link Iterable} returns an + * Interface for a Reduce Function takes in an {@link Iterable} returns an. * aggregate value computed from the {@link Iterable} */ static interface ReduceFunction<T> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java index 792b655..a2589a9 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java @@ -59,7 +59,7 @@ public interface ReduceScatter<T> extends GroupCommOperator { List<? extends Identifier> order) throws InterruptedException, NetworkException; /** - * get {@link org.apache.reef.io.network.group.api.operators.Reduce.ReduceFunction} configured + * get {@link org.apache.reef.io.network.group.api.operators.Reduce.ReduceFunction} configured. * * @return {@link org.apache.reef.io.network.group.api.operators.Reduce.ReduceFunction} */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommGroupNetworkHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommGroupNetworkHandler.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommGroupNetworkHandler.java index 45b1839..1f8a5c7 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommGroupNetworkHandler.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommGroupNetworkHandler.java @@ -25,7 +25,7 @@ import org.apache.reef.tang.annotations.Name; import org.apache.reef.wake.EventHandler; /** - * The EventHandler that receives the GroupCommunicationMsg + * The EventHandler that receives the GroupCommunicationMsg. * pertaining to a specific Communication Group */ @DefaultImplementation(value = CommGroupNetworkHandlerImpl.class) http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java index a1370e5..4c9b846 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java @@ -27,7 +27,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation; import org.apache.reef.tang.annotations.Name; /** - * The Task side interface of a communication group + * The Task side interface of a communication group. * Lets one get the operators configured for this task * and use them for communication between tasks configured * in this communication group @@ -42,7 +42,7 @@ public interface CommunicationGroupClient { Class<? extends Name<String>> getName(); /** - * The broadcast sender configured on this communication group + * The broadcast sender configured on this communication group. * with the given oepratorName * * @param operatorName @@ -51,7 +51,7 @@ public interface CommunicationGroupClient { Broadcast.Sender getBroadcastSender(Class<? extends Name<String>> operatorName); /** - * The broadcast receiver configured on this communication group + * The broadcast receiver configured on this communication group. * with the given oepratorName * * @param operatorName @@ -60,7 +60,7 @@ public interface CommunicationGroupClient { Broadcast.Receiver getBroadcastReceiver(Class<? extends Name<String>> operatorName); /** - * The reduce receiver configured on this communication group + * The reduce receiver configured on this communication group. * with the given oepratorName * * @param operatorName @@ -69,7 +69,7 @@ public interface CommunicationGroupClient { Reduce.Receiver getReduceReceiver(Class<? extends Name<String>> operatorName); /** - * The reduce sender configured on this communication group + * The reduce sender configured on this communication group. * with the given oepratorName * * @param operatorName http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupServiceClient.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupServiceClient.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupServiceClient.java index b75af08..002c275 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupServiceClient.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupServiceClient.java @@ -26,7 +26,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation; @DefaultImplementation(value = CommunicationGroupClientImpl.class) public interface CommunicationGroupServiceClient extends CommunicationGroupClient { /** - * Should not be used by user code + * Should not be used by user code. * Used for initialization of the * communication group */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java index 14c811b..512cc9e 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java @@ -26,7 +26,7 @@ import org.apache.reef.tang.annotations.Name; /** - * The task side interface for the Group Communication Service + * The task side interface for the Group Communication Service. */ @TaskSide @Provided http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommNetworkHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommNetworkHandler.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommNetworkHandler.java index ecea973..8bb59a9 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommNetworkHandler.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommNetworkHandler.java @@ -27,7 +27,7 @@ import org.apache.reef.tang.annotations.Name; import org.apache.reef.wake.EventHandler; /** - * The global EventHandler that receives the GroupCommunicationMsg + * The global EventHandler that receives the GroupCommunicationMsg. * and routes it to the relevant communication group */ @TaskSide http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessageCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessageCodec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessageCodec.java index 8b5225d..331550d 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessageCodec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessageCodec.java @@ -27,7 +27,7 @@ import javax.inject.Inject; import java.io.*; /** - * Codec for {@link GroupCommMessage} + * Codec for {@link GroupCommMessage}. */ public class GroupCommunicationMessageCodec implements StreamingCodec<GroupCommunicationMessage> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/BroadcastOperatorSpec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/BroadcastOperatorSpec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/BroadcastOperatorSpec.java index 11514b1..bc81aac 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/BroadcastOperatorSpec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/BroadcastOperatorSpec.java @@ -24,13 +24,13 @@ import org.apache.reef.io.serialization.Codec; /** - * The specification for the broadcast operator + * The specification for the broadcast operator. */ public class BroadcastOperatorSpec implements OperatorSpec { private final String senderId; /** - * Codec to be used to serialize data + * Codec to be used to serialize data. */ private final Class<? extends Codec> dataCodecClass; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/ReduceOperatorSpec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/ReduceOperatorSpec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/ReduceOperatorSpec.java index 386ad13..61759ff 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/ReduceOperatorSpec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/ReduceOperatorSpec.java @@ -24,19 +24,19 @@ import org.apache.reef.io.network.group.impl.utils.Utils; import org.apache.reef.io.serialization.Codec; /** - * The specification for the Reduce operator + * The specification for the Reduce operator. */ public class ReduceOperatorSpec implements OperatorSpec { private final String receiverId; /** - * Codec to be used to serialize data + * Codec to be used to serialize data. */ private final Class<? extends Codec> dataCodecClass; /** - * The reduce function to be used for operations that do reduction + * The reduce function to be used for operations that do reduction. */ public final Class<? extends ReduceFunction> redFuncClass; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CtrlMsgSender.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CtrlMsgSender.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CtrlMsgSender.java index 5535511..73f25bf 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CtrlMsgSender.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CtrlMsgSender.java @@ -30,7 +30,7 @@ import org.apache.reef.wake.IdentifierFactory; import java.util.logging.Logger; /** - * Event handler that receives ctrl msgs and + * Event handler that receives ctrl msgs and. * dispatched them using network service */ public class CtrlMsgSender implements EventHandler<GroupCommunicationMessage> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/FlatTopology.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/FlatTopology.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/FlatTopology.java index 70670a2..33c196d 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/FlatTopology.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/FlatTopology.java @@ -54,7 +54,7 @@ import java.util.concurrent.ConcurrentSkipListMap; import java.util.logging.Logger; /** - * Implements a one level Tree Topology + * Implements a one level Tree Topology. */ public class FlatTopology implements Topology { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java index e453640..2ce98a3 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java @@ -74,7 +74,7 @@ import java.util.logging.Logger; public class GroupCommDriverImpl implements GroupCommServiceDriver { private static final Logger LOG = Logger.getLogger(GroupCommDriverImpl.class.getName()); /** - * TANG instance + * TANG instance. */ private static final Tang tang = Tang.Factory.getTang(); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommMessageHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommMessageHandler.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommMessageHandler.java index b466205..a9ab3e9 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommMessageHandler.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommMessageHandler.java @@ -29,7 +29,7 @@ import java.util.Map; import java.util.logging.Logger; /** - * The network handler for the group communcation service on the driver side + * The network handler for the group communcation service on the driver side. */ public class GroupCommMessageHandler implements EventHandler<GroupCommunicationMessage> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommService.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommService.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommService.java index 0915fc5..24fdb71 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommService.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommService.java @@ -39,7 +39,7 @@ import javax.inject.Inject; import java.util.logging.Logger; /** - * The Group Communication Service + * The Group Communication Service. */ @Unit public class GroupCommService { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/IndexedMsg.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/IndexedMsg.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/IndexedMsg.java index b72979c..3973002 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/IndexedMsg.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/IndexedMsg.java @@ -23,7 +23,7 @@ import org.apache.reef.io.network.group.impl.utils.Utils; import org.apache.reef.tang.annotations.Name; /** - * Helper class to wrap msg and the operator name in the msg + * Helper class to wrap msg and the operator name in the msg. */ public class IndexedMsg { private final Class<? extends Name<String>> operName; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/MsgKey.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/MsgKey.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/MsgKey.java index 9ac021e..77f053b 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/MsgKey.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/MsgKey.java @@ -22,7 +22,7 @@ import org.apache.reef.io.network.group.impl.GroupCommunicationMessage; import org.apache.reef.io.network.proto.ReefNetworkGroupCommProtos; /** - * The key object used in map to aggregate msgs from + * The key object used in map to aggregate msgs from. * all the operators before updating state on driver */ public class MsgKey { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeImpl.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeImpl.java index 7483483..eeace55 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeImpl.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeImpl.java @@ -95,7 +95,7 @@ public class TaskNodeImpl implements TaskNode { } /** - * * Methods pertaining to my status change *** + * * Methods pertaining to my status change ***. */ @Override public void onFailedTask() { @@ -158,7 +158,7 @@ public class TaskNodeImpl implements TaskNode { } /** - * * Methods pertaining to my status change ends *** + * * Methods pertaining to my status change ends ***. */ @Override @@ -235,7 +235,7 @@ public class TaskNodeImpl implements TaskNode { } /** - * * Methods pertaining to my neighbors status change ends *** + * * Methods pertaining to my neighbors status change ends ***. */ @Override http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java index 3f904e2..6e8d1e6 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java @@ -108,7 +108,7 @@ public class TaskNodeStatusImpl implements TaskNodeStatus { } /** - * This needs to happen in line rather than in a stage because we need to note + * This needs to happen in line rather than in a stage because we need to note. * the messages we send to the tasks before we start processing msgs from the * nodes.(Acks & Topology msgs) */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TreeTopology.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TreeTopology.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TreeTopology.java index b1695a9..fac8f69 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TreeTopology.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TreeTopology.java @@ -56,7 +56,7 @@ import java.util.concurrent.ConcurrentSkipListMap; import java.util.logging.Logger; /** - * Implements a tree topology with the specified Fan Out + * Implements a tree topology with the specified Fan Out. */ public class TreeTopology implements Topology { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java index f46031b..028fe98 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java @@ -233,7 +233,7 @@ public class OperatorTopologyImpl implements OperatorTopology { } /** - * Only refreshes the effective topology with deletion msgs from + * Only refreshes the effective topology with deletion msgs from. * deletionDeltas queue * * @throws ParentDeadException @@ -267,7 +267,7 @@ public class OperatorTopologyImpl implements OperatorTopology { } /** - * Blocking method that waits till the base topology is updated Unblocks when + * Blocking method that waits till the base topology is updated Unblocks when. * we receive a TopologySetup msg from driver * <p/> * Will also update the effective topology when the base topology is updated http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java index 7dc651b..cc04888 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java @@ -26,7 +26,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Utility map class that wraps a CountingMap + * Utility map class that wraps a CountingMap. * in a ConcurrentMap * Equivalent to Map<K,Map<V,Integer>> */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/CountingMap.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/CountingMap.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/CountingMap.java index 58c3f5c..cfb724a 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/CountingMap.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/CountingMap.java @@ -24,7 +24,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Utility class to provide a map that allows to + * Utility class to provide a map that allows to. * add multiple keys and automatically * incrementing the count on each add * decrementing the count on each remove http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java index 6a4b424..020584f 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java @@ -23,7 +23,7 @@ import org.apache.reef.io.network.group.impl.driver.MsgKey; import java.util.*; /** - * Map from K to Set<V> + * Map from K to Set<V>. */ public class SetMap<K, V> { private final Map<K, Set<V>> map = new HashMap<>(); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSConnection.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSConnection.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSConnection.java index 43d3573..149f45b 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSConnection.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSConnection.java @@ -33,7 +33,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A connection from the network service + * A connection from the network service. */ class NSConnection<T> implements Connection<T> { @@ -49,7 +49,7 @@ class NSConnection<T> implements Connection<T> { private Link<NSMessage<T>> link; /** - * Constructs a connection + * Constructs a connection. * * @param srcId a source identifier * @param destId a destination identifier @@ -95,7 +95,7 @@ class NSConnection<T> implements Connection<T> { } /** - * Writes an object to the connection + * Writes an object to the connection. * * @param obj an object of type T * @throws a network exception @@ -106,7 +106,7 @@ class NSConnection<T> implements Connection<T> { } /** - * Closes the connection and unregisters it from the service + * Closes the connection and unregisters it from the service. */ @Override public void close() throws NetworkException { @@ -115,7 +115,7 @@ class NSConnection<T> implements Connection<T> { } /** - * No-op link listener + * No-op link listener. * * @param <T> */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessage.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessage.java index 063b9e3..28c41a4 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessage.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessage.java @@ -25,7 +25,7 @@ import java.util.ArrayList; import java.util.List; /** - * Network service message that implements the Message interface + * Network service message that implements the Message interface. * * @param <T> type */ @@ -35,7 +35,7 @@ public class NSMessage<T> implements Message<T> { private final List<T> data; /** - * Constructs a network service message + * Constructs a network service message. * * @param srcId a source identifier * @param destId a destination identifier @@ -49,7 +49,7 @@ public class NSMessage<T> implements Message<T> { } /** - * Constructs a network service message + * Constructs a network service message. * * @param srcId a source identifier * @param destId a destination identifier @@ -62,7 +62,7 @@ public class NSMessage<T> implements Message<T> { } /** - * Gets a source identifier + * Gets a source identifier. * * @return an identifier */ @@ -71,7 +71,7 @@ public class NSMessage<T> implements Message<T> { } /** - * Gets a destination identifier + * Gets a destination identifier. * * @return an identifier */ @@ -80,7 +80,7 @@ public class NSMessage<T> implements Message<T> { } /** - * Gets data + * Gets data. * * @return data */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessageCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessageCodec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessageCodec.java index f22f970..40d0b24 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessageCodec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NSMessageCodec.java @@ -32,7 +32,7 @@ import java.util.ArrayList; import java.util.List; /** - * Network service message codec + * Network service message codec. * * @param <T> type */ @@ -43,7 +43,7 @@ public class NSMessageCodec<T> implements Codec<NSMessage<T>> { private final boolean isStreamingCodec; /** - * Constructs a network service message codec + * Constructs a network service message codec. * * @param codec a codec * @param factory an identifier factory @@ -55,7 +55,7 @@ public class NSMessageCodec<T> implements Codec<NSMessage<T>> { } /** - * Encodes a network service message to bytes + * Encodes a network service message to bytes. * * @param obj a message * @return bytes @@ -91,7 +91,7 @@ public class NSMessageCodec<T> implements Codec<NSMessage<T>> { } /** - * Decodes a network service message from bytes + * Decodes a network service message from bytes. * * @param buf bytes * @return a message http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NetworkService.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NetworkService.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NetworkService.java index 3709f43..d41b538 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NetworkService.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/NetworkService.java @@ -50,7 +50,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Network service for Task + * Network service for Task. */ public final class NetworkService<T> implements Stage, ConnectionFactory<T> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/StreamingCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/StreamingCodec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/StreamingCodec.java index ac669af..56a33c4 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/StreamingCodec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/StreamingCodec.java @@ -24,7 +24,7 @@ import java.io.DataInputStream; import java.io.DataOutputStream; /** - * A codec that can make serialization more efficient when an object has to be + * A codec that can make serialization more efficient when an object has to be. * codec'ed through a chain of codecs */ public interface StreamingCodec<T> extends Codec<T> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameAssignmentTuple.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameAssignmentTuple.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameAssignmentTuple.java index c7792fd..649078b 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameAssignmentTuple.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameAssignmentTuple.java @@ -24,7 +24,7 @@ import org.apache.reef.wake.Identifier; import java.net.InetSocketAddress; /** - * An implementation of the NameAssignment interface + * An implementation of the NameAssignment interface. */ public class NameAssignmentTuple implements NameAssignment { @@ -32,7 +32,7 @@ public class NameAssignmentTuple implements NameAssignment { private final InetSocketAddress addr; /** - * Constructs a name assignment tuple + * Constructs a name assignment tuple. * * @param id an identifier * @param addr an Internet socket address @@ -43,7 +43,7 @@ public class NameAssignmentTuple implements NameAssignment { } /** - * Gets an identifier + * Gets an identifier. * * @return an identifier */ @@ -53,7 +53,7 @@ public class NameAssignmentTuple implements NameAssignment { } /** - * Gets an address + * Gets an address. * * @return an Internet socket address */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameCache.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameCache.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameCache.java index e32b144..4eededa 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameCache.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameCache.java @@ -28,14 +28,14 @@ import java.util.concurrent.Callable; import java.util.concurrent.ExecutionException; /** - * Naming cache implementation + * Naming cache implementation. */ public class NameCache implements Cache<Identifier, InetSocketAddress> { private final Cache<Identifier, InetSocketAddress> cache; /** - * Constructs a naming cache + * Constructs a naming cache. * * @param timeout a cache entry timeout after write */ @@ -44,7 +44,7 @@ public class NameCache implements Cache<Identifier, InetSocketAddress> { } /** - * Gets an address for an identifier + * Gets an address for an identifier. * * @param key an identifier * @param valueFetcher a callable to load a value for the corresponding identifier @@ -58,7 +58,7 @@ public class NameCache implements Cache<Identifier, InetSocketAddress> { } /** - * Invalidates the entry for an identifier + * Invalidates the entry for an identifier. * * @param key an identifier */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameClient.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameClient.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameClient.java index 3efef65..bdeb7db 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameClient.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameClient.java @@ -45,7 +45,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Naming client + * Naming client. */ public class NameClient implements Stage, Naming { private static final Logger LOG = Logger.getLogger(NameClient.class.getName()); @@ -66,7 +66,7 @@ public class NameClient implements Stage, Naming { } /** - * Constructs a naming client + * Constructs a naming client. * * @param serverAddr a server address * @param serverPort a server port number @@ -102,7 +102,7 @@ public class NameClient implements Stage, Naming { } /** - * Constructs a naming client + * Constructs a naming client. * * @param serverAddr a server address * @param serverPort a server port number @@ -123,7 +123,7 @@ public class NameClient implements Stage, Naming { } /** - * Constructs a naming client + * Constructs a naming client. * * @param serverAddr a server address * @param serverPort a server port number @@ -159,7 +159,7 @@ public class NameClient implements Stage, Naming { } /** - * Registers an (identifier, address) mapping + * Registers an (identifier, address) mapping. * * @param id an identifier * @param addr an Internet socket address @@ -172,7 +172,7 @@ public class NameClient implements Stage, Naming { } /** - * Unregisters an identifier + * Unregisters an identifier. * * @param id an identifier */ @@ -182,7 +182,7 @@ public class NameClient implements Stage, Naming { } /** - * Finds an address for an identifier + * Finds an address for an identifier. * * @param id an identifier * @return an Internet socket address @@ -193,7 +193,7 @@ public class NameClient implements Stage, Naming { } /** - * Retrieves an address for an identifier remotely + * Retrieves an address for an identifier remotely. * * @param id an identifier * @return an Internet socket address @@ -204,7 +204,7 @@ public class NameClient implements Stage, Naming { } /** - * Closes resources + * Closes resources. */ @Override public void close() throws Exception { @@ -224,7 +224,7 @@ public class NameClient implements Stage, Naming { } /** - * Naming client transport event handler + * Naming client transport event handler. */ class NamingClientEventHandler implements EventHandler<TransportEvent> { @@ -247,7 +247,7 @@ class NamingClientEventHandler implements EventHandler<TransportEvent> { } /** - * Naming response message handler + * Naming response message handler. */ class NamingResponseHandler implements EventHandler<NamingMessage> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameLookupClient.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameLookupClient.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameLookupClient.java index fdef6f0..d4e38da 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameLookupClient.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameLookupClient.java @@ -54,7 +54,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Naming lookup client + * Naming lookup client. */ public class NameLookupClient implements Stage, NamingLookup { @@ -69,7 +69,7 @@ public class NameLookupClient implements Stage, NamingLookup { private final int retryTimeout; /** - * Constructs a naming lookup client + * Constructs a naming lookup client. * * @param serverAddr a server address * @param serverPort a server port number @@ -87,7 +87,7 @@ public class NameLookupClient implements Stage, NamingLookup { } /** - * Constructs a naming lookup client + * Constructs a naming lookup client. * * @param serverAddr a server address * @param serverPort a server port number @@ -123,7 +123,7 @@ public class NameLookupClient implements Stage, NamingLookup { } /** - * Constructs a naming lookup client + * Constructs a naming lookup client. * * @param serverAddr a server address * @param serverPort a server port number @@ -144,7 +144,7 @@ public class NameLookupClient implements Stage, NamingLookup { } /** - * Constructs a naming lookup client + * Constructs a naming lookup client. * * @param serverAddr a server address * @param serverPort a server port number @@ -195,7 +195,7 @@ public class NameLookupClient implements Stage, NamingLookup { /** - * Finds an address for an identifier + * Finds an address for an identifier. * * @param id an identifier * @return an Internet socket address @@ -233,7 +233,7 @@ public class NameLookupClient implements Stage, NamingLookup { } /** - * Retrieves an address for an identifier remotely + * Retrieves an address for an identifier remotely. * * @param id an identifier * @return an Internet socket address @@ -273,7 +273,7 @@ public class NameLookupClient implements Stage, NamingLookup { } /** - * Closes resources + * Closes resources. */ @Override public void close() throws Exception { @@ -291,7 +291,7 @@ public class NameLookupClient implements Stage, NamingLookup { } /** - * Naming lookup client transport event handler + * Naming lookup client transport event handler. */ class NamingLookupClientHandler implements EventHandler<TransportEvent> { @@ -311,7 +311,7 @@ class NamingLookupClientHandler implements EventHandler<TransportEvent> { } /** - * Naming lookup response handler + * Naming lookup response handler. */ class NamingLookupResponseHandler implements EventHandler<NamingLookupResponse> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameRegistryClient.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameRegistryClient.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameRegistryClient.java index 24056dd..a22820b 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameRegistryClient.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameRegistryClient.java @@ -52,7 +52,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Naming registry client + * Naming registry client. */ public class NameRegistryClient implements Stage, NamingRegistry { @@ -65,7 +65,7 @@ public class NameRegistryClient implements Stage, NamingRegistry { private final long timeout; /** - * Constructs a naming registry client + * Constructs a naming registry client. * * @param serverAddr a name server address * @param serverPort a name server port @@ -77,7 +77,7 @@ public class NameRegistryClient implements Stage, NamingRegistry { } /** - * Constructs a naming registry client + * Constructs a naming registry client. * * @param serverAddr a name server address * @param serverPort a name server port @@ -132,7 +132,7 @@ public class NameRegistryClient implements Stage, NamingRegistry { } /** - * Registers an (identifier, address) mapping + * Registers an (identifier, address) mapping. * * @param id an identifier * @param addr an Internet socket address @@ -164,7 +164,7 @@ public class NameRegistryClient implements Stage, NamingRegistry { } /** - * Unregisters an identifier + * Unregisters an identifier. * * @param id an identifier */ @@ -176,7 +176,7 @@ public class NameRegistryClient implements Stage, NamingRegistry { } /** - * Closes resources + * Closes resources. */ @Override public void close() throws Exception { @@ -186,7 +186,7 @@ public class NameRegistryClient implements Stage, NamingRegistry { } /** - * Naming registry client transport event handler + * Naming registry client transport event handler. */ class NamingRegistryClientHandler implements EventHandler<TransportEvent> { private static final Logger LOG = Logger.getLogger(NamingRegistryClientHandler.class.getName()); @@ -207,7 +207,7 @@ class NamingRegistryClientHandler implements EventHandler<TransportEvent> { } /** - * Naming register response handler + * Naming register response handler. */ class NamingRegistryResponseHandler implements EventHandler<NamingRegisterResponse> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServer.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServer.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServer.java index 0737286..312a1b9 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServer.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServer.java @@ -27,18 +27,18 @@ import java.net.InetSocketAddress; import java.util.List; /** - * Naming server interface + * Naming server interface. */ public interface NameServer extends Stage { /** - * get port number + * get port number. * @return */ public int getPort(); /** - * Registers an (identifier, address) mapping locally + * Registers an (identifier, address) mapping locally. * * @param id an identifier * @param addr an Internet socket address @@ -46,14 +46,14 @@ public interface NameServer extends Stage { public void register(final Identifier id, final InetSocketAddress addr); /** - * Unregisters an identifier locally + * Unregisters an identifier locally. * * @param id an identifier */ public void unregister(final Identifier id); /** - * Finds an address for an identifier locally + * Finds an address for an identifier locally. * * @param id an identifier * @return an Internet socket address @@ -61,10 +61,10 @@ public interface NameServer extends Stage { public InetSocketAddress lookup(final Identifier id); /** - * Finds addresses for identifiers locally + * Finds addresses for identifiers locally. * * @param identifiers an Iterable of identifiers * @return a list of name assignments */ public List<NameAssignment> lookup(final Iterable<Identifier> identifiers); -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerConfiguration.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerConfiguration.java index 1912686..5215a04 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerConfiguration.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerConfiguration.java @@ -25,20 +25,20 @@ import org.apache.reef.tang.formats.OptionalParameter; import org.apache.reef.wake.IdentifierFactory; /** - * Configuration Module Builder for NameServer + * Configuration Module Builder for NameServer. */ public final class NameServerConfiguration extends ConfigurationModuleBuilder { /** - * The port used by name server + * The port used by name server. */ public static final OptionalParameter<Integer> NAME_SERVICE_PORT = new OptionalParameter<>(); /** - * DNS hostname running the name service + * DNS hostname running the name service. */ public static final OptionalParameter<String> NAME_SERVER_HOSTNAME = new OptionalParameter<>(); /** - * Identifier factory for the name service + * Identifier factory for the name service. */ public static final OptionalParameter<IdentifierFactory> NAME_SERVER_IDENTIFIER_FACTORY = new OptionalParameter<>();
