http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Stage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Stage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Stage.java index df79d0f..5ea1852 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Stage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Stage.java @@ -19,7 +19,7 @@ package org.apache.reef.wake; /** - * Stage is an execution unit for events and provides a way to reclaim its resources + * Stage is an execution unit for events and provides a way to reclaim its resources. */ public interface Stage extends AutoCloseable { }
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/StageConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/StageConfiguration.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/StageConfiguration.java index 0ccbb3a..3dcf9c0 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/StageConfiguration.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/StageConfiguration.java @@ -25,7 +25,7 @@ import org.apache.reef.wake.rx.Observer; import java.util.concurrent.ExecutorService; /** - * Configuration options for Wake Stage + * Configuration options for Wake Stage. */ public final class StageConfiguration { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/WakeConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/WakeConfiguration.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/WakeConfiguration.java index 7adee0b..3244d12 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/WakeConfiguration.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/WakeConfiguration.java @@ -34,7 +34,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Wake parameter configuration + * Wake parameter configuration. */ public final class WakeConfiguration { private final static Logger LOG = Logger.getLogger(WakeConfiguration.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/exception/WakeRuntimeException.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/exception/WakeRuntimeException.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/exception/WakeRuntimeException.java index 87aa414..befa45b 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/exception/WakeRuntimeException.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/exception/WakeRuntimeException.java @@ -19,14 +19,14 @@ package org.apache.reef.wake.exception; /** - * Wake runtime exception + * Wake runtime exception. */ public class WakeRuntimeException extends RuntimeException { private static final long serialVersionUID = 1L; /** - * Constructs a new runtime wake exception with the specified detail message and cause + * Constructs a new runtime wake exception with the specified detail message and cause. * * @param s the detailed message * @param e the cause @@ -36,7 +36,7 @@ public class WakeRuntimeException extends RuntimeException { } /** - * Constructs a new runtime stage exception with the specified detail message + * Constructs a new runtime stage exception with the specified detail message. * * @param s the detailed message */ @@ -45,7 +45,7 @@ public class WakeRuntimeException extends RuntimeException { } /** - * Constructs a new runtime stage exception with the specified cause + * Constructs a new runtime stage exception with the specified cause. * * @param e the cause */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultIdentifierFactory.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultIdentifierFactory.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultIdentifierFactory.java index a186659..e03c991 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultIdentifierFactory.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultIdentifierFactory.java @@ -43,7 +43,7 @@ public class DefaultIdentifierFactory implements IdentifierFactory { private final Map<String, Class<? extends Identifier>> typeToClazzMap; /** - * Constructs a default remote identifier factory + * Constructs a default remote identifier factory. */ @Inject public DefaultIdentifierFactory() { @@ -52,7 +52,7 @@ public class DefaultIdentifierFactory implements IdentifierFactory { } /** - * Constructs a default remote identifier factory + * Constructs a default remote identifier factory. * * @param typeToClazzMap the map of type strings to classes of remote identifiers */ @@ -61,7 +61,7 @@ public class DefaultIdentifierFactory implements IdentifierFactory { } /** - * Creates a new remote identifier instance + * Creates a new remote identifier instance. * * @param str a string representation * @return a remote identifier http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultThreadFactory.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultThreadFactory.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultThreadFactory.java index 71c123e..047dc88 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultThreadFactory.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/DefaultThreadFactory.java @@ -22,7 +22,7 @@ import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicInteger; /** - * A default thread factory implementation that names created threads + * A default thread factory implementation that names created threads. */ public final class DefaultThreadFactory implements ThreadFactory { private static final AtomicInteger poolNumber = new AtomicInteger(1); @@ -32,7 +32,7 @@ public final class DefaultThreadFactory implements ThreadFactory { private Thread.UncaughtExceptionHandler uncaughtExceptionHandler; /** - * Constructs a default thread factory + * Constructs a default thread factory. * * @param prefix the name prefix of the created thread */ @@ -44,7 +44,7 @@ public final class DefaultThreadFactory implements ThreadFactory { } /** - * Constructs a default thread factory + * Constructs a default thread factory. * * @param prefix the name prefix of the created thread * @param uncaughtExceptionHandler the uncaught exception handler of the created thread @@ -57,7 +57,7 @@ public final class DefaultThreadFactory implements ThreadFactory { } /** - * Sets a uncaught exception handler + * Sets a uncaught exception handler. * * @param uncaughtExceptionHandler the uncaught exception handler */ @@ -66,7 +66,7 @@ public final class DefaultThreadFactory implements ThreadFactory { } /** - * Creates a new thread + * Creates a new thread. * * @param r the runnable */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingEventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingEventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingEventHandler.java index 86269a4..bef2e94 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingEventHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingEventHandler.java @@ -25,7 +25,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A logging event handler + * A logging event handler. * * @param <T> type */ @@ -37,7 +37,7 @@ public class LoggingEventHandler<T> implements EventHandler<T> { } /** - * Logs the event + * Logs the event. * * @param value an event */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingUtils.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingUtils.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingUtils.java index b85c37c..7064f14 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingUtils.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingUtils.java @@ -24,12 +24,12 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Utility for logging + * Utility for logging. */ public class LoggingUtils { /** - * Sets the logging level + * Sets the logging level. * * @param level the logging level */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingVoidEventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingVoidEventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingVoidEventHandler.java index d9f923f..ce6a509 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingVoidEventHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/LoggingVoidEventHandler.java @@ -25,7 +25,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A logging void event handler + * A logging void event handler. */ public class LoggingVoidEventHandler implements EventHandler<Void> { private static final Logger LOG = Logger.getLogger(LoggingVoidEventHandler.class.getName()); @@ -35,7 +35,7 @@ public class LoggingVoidEventHandler implements EventHandler<Void> { } /** - * Logs the event + * Logs the event. * * @param value an event */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/MultiEventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/MultiEventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/MultiEventHandler.java index 0c026b2..8a2774a 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/MultiEventHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/MultiEventHandler.java @@ -24,7 +24,7 @@ import org.apache.reef.wake.exception.WakeRuntimeException; import java.util.Map; /** - * Event handler that dispatches an event to a specific handler based on an event class type + * Event handler that dispatches an event to a specific handler based on an event class type. * * @param <T> type */ @@ -33,7 +33,7 @@ public class MultiEventHandler<T> implements EventHandler<T> { private final Map<Class<? extends T>, EventHandler<? extends T>> map; /** - * Constructs a multi-event handler + * Constructs a multi-event handler. * * @param map a map of class types to event handlers */ @@ -42,7 +42,7 @@ public class MultiEventHandler<T> implements EventHandler<T> { } /** - * Invokes a specific handler for the event class type if it exists + * Invokes a specific handler for the event class type if it exists. * * @param an event * @throws WakeRuntimeException http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PeriodicEvent.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PeriodicEvent.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PeriodicEvent.java index 5c53425..ff85846 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PeriodicEvent.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PeriodicEvent.java @@ -19,7 +19,7 @@ package org.apache.reef.wake.impl; /** - * Periodic event for timers + * Periodic event for timers. */ public class PeriodicEvent { } http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PubSubEventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PubSubEventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PubSubEventHandler.java index 721a6e2..3ff6be5 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PubSubEventHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/PubSubEventHandler.java @@ -31,7 +31,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Event handler that provides publish/subscribe interfaces + * Event handler that provides publish/subscribe interfaces. * * @param <T> type */ @@ -42,14 +42,14 @@ public class PubSubEventHandler<T> implements EventHandler<T> { private final ReadWriteLock lock = new ReentrantReadWriteLock(); /** - * Constructs a pub-sub event handler + * Constructs a pub-sub event handler. */ public PubSubEventHandler() { this.clazzToListOfHandlersMap = new HashMap<Class<? extends T>, List<EventHandler<? extends T>>>(); } /** - * Constructs a pub-sub event handler with initial subscribed event handlers + * Constructs a pub-sub event handler with initial subscribed event handlers. * * @param map a map of event class types to lists of event handlers */ @@ -58,7 +58,7 @@ public class PubSubEventHandler<T> implements EventHandler<T> { } /** - * Subscribes an event handler for an event class type + * Subscribes an event handler for an event class type. * * @param clazz an event class * @param handler an event handler @@ -78,7 +78,7 @@ public class PubSubEventHandler<T> implements EventHandler<T> { } /** - * Invokes subscribed handlers for the event class type + * Invokes subscribed handlers for the event class type. * * @param event an event * @throws WakeRuntimeException http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SingleThreadStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SingleThreadStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SingleThreadStage.java index addc0d9..8141087 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SingleThreadStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SingleThreadStage.java @@ -33,7 +33,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Single thread stage that runs the event handler + * Single thread stage that runs the event handler. * * @param <T> type */ @@ -45,7 +45,7 @@ public final class SingleThreadStage<T> extends AbstractEStage<T> { private final AtomicBoolean interrupted; /** - * Constructs a single thread stage + * Constructs a single thread stage. * * @param handler the event handler to execute * @param capacity the queue capacity @@ -57,7 +57,7 @@ public final class SingleThreadStage<T> extends AbstractEStage<T> { } /** - * Constructs a single thread stage + * Constructs a single thread stage. * * @param name the stage name * @param handler the event handler to execute @@ -77,7 +77,7 @@ public final class SingleThreadStage<T> extends AbstractEStage<T> { } /** - * Puts the value to the queue, which will be processed by the handler later + * Puts the value to the queue, which will be processed by the handler later. * if the queue is full, IllegalStateException is thrown * * @param value the value @@ -90,7 +90,7 @@ public final class SingleThreadStage<T> extends AbstractEStage<T> { } /** - * Closes the stage + * Closes the stage. * * @throws Exception */ @@ -104,7 +104,7 @@ public final class SingleThreadStage<T> extends AbstractEStage<T> { /** - * Takes events from the queue and provides them to the handler + * Takes events from the queue and provides them to the handler. */ private class Producer<U> implements Runnable { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/StageManager.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/StageManager.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/StageManager.java index b2db379..10d79e2 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/StageManager.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/StageManager.java @@ -28,7 +28,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A manager that manages all the stage + * A manager that manages all the stage. */ public final class StageManager implements Stage { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SyncStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SyncStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SyncStage.java index db40d85..29fd03b 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SyncStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/SyncStage.java @@ -30,7 +30,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Stage that synchronously executes an event handler + * Stage that synchronously executes an event handler. * * @param <T> type */ @@ -42,7 +42,7 @@ public final class SyncStage<T> extends AbstractEStage<T> { private final EventHandler<Throwable> errorHandler; /** - * Constructs a synchronous stage + * Constructs a synchronous stage. * * @param handler the event handler */ @@ -52,7 +52,7 @@ public final class SyncStage<T> extends AbstractEStage<T> { } /** - * Constructs a synchronous stage + * Constructs a synchronous stage. * * @param handler the event handler * @name name the stage name @@ -64,7 +64,7 @@ public final class SyncStage<T> extends AbstractEStage<T> { } /** - * Constructs a synchronous stage + * Constructs a synchronous stage. * * @param handler the event handler * @param errorHandler the error handler @@ -81,7 +81,7 @@ public final class SyncStage<T> extends AbstractEStage<T> { } /** - * Invokes the handler for the event + * Invokes the handler for the event. * * @param value the event */ @@ -102,7 +102,7 @@ public final class SyncStage<T> extends AbstractEStage<T> { } /** - * Closes resources + * Closes resources. * * @throws Exception */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ThreadPoolStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ThreadPoolStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ThreadPoolStage.java index 8729ab3..c5438c6 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ThreadPoolStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/ThreadPoolStage.java @@ -35,7 +35,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Stage that executes an event handler with a thread pool + * Stage that executes an event handler with a thread pool. * * @param <T> type */ @@ -49,7 +49,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { private final EventHandler<Throwable> errorHandler; /** - * Constructs a thread-pool stage + * Constructs a thread-pool stage. * * @param handler the event handler to execute * @param numThreads the number of threads to use @@ -62,7 +62,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { } /** - * Constructs a thread-pool stage + * Constructs a thread-pool stage. * * @param name the stage name * @param handler the event handler to execute @@ -86,7 +86,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { } /** - * Constructs a thread-pool stage + * Constructs a thread-pool stage. * * @param name the stage name * @param handler the event handler to execute @@ -101,7 +101,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { } /** - * Constructs a thread-pool stage + * Constructs a thread-pool stage. * * @param handler the event handler to execute * @param executor the external executor service provided @@ -114,7 +114,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { /** - * Constructs a thread-pool stage + * Constructs a thread-pool stage. * * @param handler the event handler to execute * @param executor the external executor service provided @@ -128,7 +128,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { } /** - * Constructs a thread-pool stage + * Constructs a thread-pool stage. * * @param name the stage name * @param handler the event handler to execute @@ -143,7 +143,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { } /** - * Constructs a thread-pool stage + * Constructs a thread-pool stage. * * @param name the stage name * @param handler the event handler to execute @@ -165,7 +165,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { } /** - * Handles the event using a thread in the thread pool + * Handles the event using a thread in the thread pool. * * @param value the event */ @@ -193,7 +193,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { } /** - * Closes resources + * Closes resources. * * @return Exception */ @@ -212,7 +212,7 @@ public final class ThreadPoolStage<T> extends AbstractEStage<T> { } /** - * Gets the queue length of this stage + * Gets the queue length of this stage. * * @return the queue length */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/TimerStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/TimerStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/TimerStage.java index 2e423b6..fa05d08 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/TimerStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/TimerStage.java @@ -37,7 +37,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Stage that triggers an event handler periodically + * Stage that triggers an event handler periodically. */ public final class TimerStage implements Stage { private static final Logger LOG = Logger.getLogger(TimerStage.class.getName()); @@ -48,7 +48,7 @@ public final class TimerStage implements Stage { private final long shutdownTimeout = WakeParameters.EXECUTOR_SHUTDOWN_TIMEOUT; /** - * Constructs a timer stage with no initial delay + * Constructs a timer stage with no initial delay. * * @param handler an event handler * @param period a period in milli-seconds @@ -60,7 +60,7 @@ public final class TimerStage implements Stage { } /** - * Constructs a timer stage with no initial delay + * Constructs a timer stage with no initial delay. * * @param handler an event handler * @param period a period in milli-seconds @@ -74,7 +74,7 @@ public final class TimerStage implements Stage { } /** - * Constructs a timer stage + * Constructs a timer stage. * * @param handler an event handler * @param initialDelay an initial delay @@ -88,7 +88,7 @@ public final class TimerStage implements Stage { } /** - * Constructs a timer stage + * Constructs a timer stage. * * @param name the stage name * @param handler an event handler @@ -115,7 +115,7 @@ public final class TimerStage implements Stage { /** - * Closes resources + * Closes resources. * * @throws Exception */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeUncaughtExceptionHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeUncaughtExceptionHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeUncaughtExceptionHandler.java index fb11336..f201742 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeUncaughtExceptionHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/impl/WakeUncaughtExceptionHandler.java @@ -21,7 +21,7 @@ package org.apache.reef.wake.impl; import org.apache.reef.wake.EventHandler; /** - * Exception handler for uncaught exceptions + * Exception handler for uncaught exceptions. */ public final class WakeUncaughtExceptionHandler implements Thread.UncaughtExceptionHandler { private EventHandler<Throwable> errorHandler; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMA.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMA.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMA.java index b9bbe8f..a879f4b 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMA.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMA.java @@ -22,7 +22,7 @@ import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicLong; /** - * Exponentially weighted moving average + * Exponentially weighted moving average. */ public class EWMA { @@ -33,7 +33,7 @@ public class EWMA { private volatile double rate = 0.0; /** - * Constructs an EWMA object + * Constructs an EWMA object. * * @param alpha * @param interval @@ -45,7 +45,7 @@ public class EWMA { } /** - * Updates the EWMA with a new value + * Updates the EWMA with a new value. * * @param n the new value */ @@ -54,7 +54,7 @@ public class EWMA { } /** - * Updates the rate + * Updates the rate. */ public void tick() { final long count = uncounted.getAndSet(0); @@ -68,7 +68,7 @@ public class EWMA { } /** - * Gets the rate + * Gets the rate. * * @param rateUnit the unit of the rate * @return the rate http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMAParameters.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMAParameters.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMAParameters.java index 3480546..02fd94c 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMAParameters.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/EWMAParameters.java @@ -21,7 +21,7 @@ package org.apache.reef.wake.metrics; import static java.lang.Math.exp; /** - * Default EWMA parameters + * Default EWMA parameters. */ public class EWMAParameters { public static final int INTERVAL = 5; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Histogram.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Histogram.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Histogram.java index 9c331b3..88af4d5 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Histogram.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Histogram.java @@ -19,26 +19,26 @@ package org.apache.reef.wake.metrics; /** - * Histogram + * Histogram. */ public interface Histogram { /** - * Updates the value in this histogram + * Updates the value in this histogram. * * @param value the new value */ public void update(long value); /** - * Returns the number of recorded values + * Returns the number of recorded values. * * @return the number of recorded values */ public long getCount(); /** - * Returns the value of the index + * Returns the value of the index. * * @param index the histogram bin index * @return the value of the index @@ -47,7 +47,7 @@ public interface Histogram { public long getValue(int index); /** - * Returns the number of bins + * Returns the number of bins. * * @return the number of bins */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Meter.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Meter.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Meter.java index 4ca3512..e2b6e28 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Meter.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/Meter.java @@ -22,7 +22,7 @@ import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicLong; /** - * Meter that monitors mean throughput and ewma (1m, 5m, 15m) throughput + * Meter that monitors mean throughput and ewma (1m, 5m, 15m) throughput. */ public class Meter { @@ -39,7 +39,7 @@ public class Meter { private final String name; /** - * Constructs a meter + * Constructs a meter. * * @param name the name of the meter */ @@ -53,7 +53,7 @@ public class Meter { } /** - * Gets the name of the meter + * Gets the name of the meter. * * @return the meter name */ @@ -62,7 +62,7 @@ public class Meter { } /** - * Marks the number of events + * Marks the number of events. * * @param n the number of events */ @@ -75,7 +75,7 @@ public class Meter { } /** - * Gets the count + * Gets the count. * * @return the count */ @@ -84,7 +84,7 @@ public class Meter { } /** - * Gets the mean throughput + * Gets the mean throughput. * * @return the mean throughput */ @@ -98,7 +98,7 @@ public class Meter { } /** - * Gets the 1-minute EWMA throughput + * Gets the 1-minute EWMA throughput. * * @return the 1-minute EWMA throughput */ @@ -108,7 +108,7 @@ public class Meter { } /** - * Gets the 5-minute EWMA throughput + * Gets the 5-minute EWMA throughput. * * @return the 5-minute EWMA throughput */ @@ -118,7 +118,7 @@ public class Meter { } /** - * Gets the 15-minute EWMA throughput + * Gets the 15-minute EWMA throughput. * * @return the 15-minute EWMA throughput */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/UniformHistogram.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/UniformHistogram.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/UniformHistogram.java index 8d6d794..fc0be40 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/UniformHistogram.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/metrics/UniformHistogram.java @@ -22,7 +22,7 @@ import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.atomic.AtomicLongArray; /** - * An {@link Histogram} that implements uniform binning of numbers (>=0) + * An {@link Histogram} that implements uniform binning of numbers (>=0). */ public class UniformHistogram implements Histogram { private final AtomicLong count; @@ -31,7 +31,7 @@ public class UniformHistogram implements Histogram { private final int numBins; /** - * Constructs a histogram + * Constructs a histogram. * * @param binWidth the width of each bin * @param numBins the number of bins @@ -44,7 +44,7 @@ public class UniformHistogram implements Histogram { } /** - * Updates the value + * Updates the value. * * @param value */ @@ -58,7 +58,7 @@ public class UniformHistogram implements Histogram { } /** - * Returns the number of recorded values + * Returns the number of recorded values. * * @return the number of recorded values */ @@ -68,7 +68,7 @@ public class UniformHistogram implements Histogram { } /** - * Returns the value of the index + * Returns the value of the index. * * @param index the index * @return the value of the index @@ -79,7 +79,7 @@ public class UniformHistogram implements Histogram { } /** - * Returns the number of bins + * Returns the number of bins. * * @return the number of bins */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Decoder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Decoder.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Decoder.java index 45162c1..32c4807 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Decoder.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Decoder.java @@ -27,7 +27,7 @@ package org.apache.reef.wake.remote; public interface Decoder<T> { /** - * Decodes the given byte array into an object + * Decodes the given byte array into an object. * * @param buf * @return the decoded object http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/DefaultErrorHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/DefaultErrorHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/DefaultErrorHandler.java index f900d5e..a280a47 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/DefaultErrorHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/DefaultErrorHandler.java @@ -23,7 +23,7 @@ import org.apache.reef.wake.EventHandler; import javax.inject.Inject; /** - * The default RemoteConfiguration.ErrorHandler + * The default RemoteConfiguration.ErrorHandler. */ final class DefaultErrorHandler implements EventHandler<Throwable> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Encoder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Encoder.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Encoder.java index 184d982..7f96be2 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Encoder.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/Encoder.java @@ -27,7 +27,7 @@ package org.apache.reef.wake.remote; public interface Encoder<T> { /** - * Encodes the given object into a Byte Array + * Encodes the given object into a Byte Array. * * @param obj * @return a byte[] representation of the object http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifier.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifier.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifier.java index 7ef432f..2ed97d3 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifier.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifier.java @@ -21,7 +21,7 @@ package org.apache.reef.wake.remote; import org.apache.reef.wake.Identifier; /** - * Wake remote identifier + * Wake remote identifier. */ public interface RemoteIdentifier extends Identifier { } http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifierFactory.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifierFactory.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifierFactory.java index c30cd22..5e4128c 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifierFactory.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteIdentifierFactory.java @@ -24,7 +24,7 @@ import org.apache.reef.wake.IdentifierFactory; import org.apache.reef.wake.remote.impl.DefaultRemoteIdentifierFactoryImplementation; /** - * Factory that creates a RemoteIdentifier + * Factory that creates a RemoteIdentifier. */ @DefaultImplementation(DefaultRemoteIdentifierFactoryImplementation.class) public interface RemoteIdentifierFactory extends IdentifierFactory { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteMessage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteMessage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteMessage.java index b7daa2f..dd9971d 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteMessage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/RemoteMessage.java @@ -19,21 +19,21 @@ package org.apache.reef.wake.remote; /** - * Message received from a remote handler + * Message received from a remote handler. * * @param <T> type */ public interface RemoteMessage<T> { /** - * Returns a remote identifier of the sender + * Returns a remote identifier of the sender. * * @return a remote identifier */ public RemoteIdentifier getIdentifier(); /** - * Returns an actual message + * Returns an actual message. * * @return a message */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/HostnameBasedLocalAddressProvider.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/HostnameBasedLocalAddressProvider.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/HostnameBasedLocalAddressProvider.java index 844cb8e..d8789c2 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/HostnameBasedLocalAddressProvider.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/HostnameBasedLocalAddressProvider.java @@ -28,7 +28,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A LocalAddressProvider that uses <code>Inet4Address.getLocalHost().getHostAddress()</code> + * A LocalAddressProvider that uses <code>Inet4Address.getLocalHost().getHostAddress()</code>. */ public final class HostnameBasedLocalAddressProvider implements LocalAddressProvider { private static final Logger LOG = Logger.getLogger(HostnameBasedLocalAddressProvider.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/LegacyLocalAddressProvider.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/LegacyLocalAddressProvider.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/LegacyLocalAddressProvider.java index 7ab18fc..6a3f758 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/LegacyLocalAddressProvider.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/address/LegacyLocalAddressProvider.java @@ -35,7 +35,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * An implementation of LocalAddressProvider using the (removed) code from NetUtils.getLocalAddress() + * An implementation of LocalAddressProvider using the (removed) code from NetUtils.getLocalAddress(). */ public final class LegacyLocalAddressProvider implements LocalAddressProvider { private static final Logger LOG = Logger.getLogger(LegacyLocalAddressProvider.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/exception/RemoteRuntimeException.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/exception/RemoteRuntimeException.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/exception/RemoteRuntimeException.java index c7b9f2e..258d365 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/exception/RemoteRuntimeException.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/exception/RemoteRuntimeException.java @@ -19,13 +19,13 @@ package org.apache.reef.wake.remote.exception; /** - * Wake remote runtime exception + * Wake remote runtime exception. */ public class RemoteRuntimeException extends RuntimeException { private static final long serialVersionUID = 1L; /** - * Constructs a new runtime remote exception with the specified detail message and cause + * Constructs a new runtime remote exception with the specified detail message and cause. * * @param s the detailed message * @param e the cause @@ -35,7 +35,7 @@ public class RemoteRuntimeException extends RuntimeException { } /** - * Constructs a new runtime remote exception with the specified detail message + * Constructs a new runtime remote exception with the specified detail message. * * @param s the detailed message */ @@ -44,7 +44,7 @@ public class RemoteRuntimeException extends RuntimeException { } /** - * Constructs a new runtime remote exception with the specified cause + * Constructs a new runtime remote exception with the specified cause. * * @param e the cause */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ByteCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ByteCodec.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ByteCodec.java index b4760bd..bc9b4d3 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ByteCodec.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ByteCodec.java @@ -21,12 +21,12 @@ package org.apache.reef.wake.remote.impl; import org.apache.reef.wake.remote.Codec; /** - * Codec that performs identity transformation on bytes + * Codec that performs identity transformation on bytes. */ public class ByteCodec implements Codec<byte[]> { /** - * Returns the byte array argument + * Returns the byte array argument. * * @param obj bytes * @return the same bytes @@ -37,7 +37,7 @@ public class ByteCodec implements Codec<byte[]> { } /** - * Returns the byte array argument + * Returns the byte array argument. * * @param buf bytes * @return the same bytes http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteManagerImplementation.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteManagerImplementation.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteManagerImplementation.java index 7fbe59e..c2b8e65 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteManagerImplementation.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteManagerImplementation.java @@ -41,7 +41,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Default remote manager implementation + * Default remote manager implementation. */ public class DefaultRemoteManagerImplementation implements RemoteManager { @@ -50,7 +50,7 @@ public class DefaultRemoteManagerImplementation implements RemoteManager { private static final AtomicInteger counter = new AtomicInteger(0); /** - * The timeout used for the execute running in close() + * The timeout used for the execute running in close(). */ private static final long CLOSE_EXECUTOR_TIMEOUT = 10000; //ms private final AtomicBoolean closed = new AtomicBoolean(false); @@ -135,7 +135,7 @@ public class DefaultRemoteManagerImplementation implements RemoteManager { } /** - * Returns a proxy event handler for a remote identifier and a message type + * Returns a proxy event handler for a remote identifier and a message type. */ @Override public <T> EventHandler<T> getHandler( @@ -151,7 +151,7 @@ public class DefaultRemoteManagerImplementation implements RemoteManager { } /** - * Registers an event handler for a remote identifier and a message type and + * Registers an event handler for a remote identifier and a message type and. * returns a subscription */ @Override @@ -167,7 +167,7 @@ public class DefaultRemoteManagerImplementation implements RemoteManager { } /** - * Registers an event handler for a message type and returns a subscription + * Registers an event handler for a message type and returns a subscription. */ @Override public <T, U extends T> AutoCloseable registerHandler( @@ -180,7 +180,7 @@ public class DefaultRemoteManagerImplementation implements RemoteManager { } /** - * Registers an exception handler and returns a subscription + * Registers an exception handler and returns a subscription. */ @Override public AutoCloseable registerErrorHandler(final EventHandler<Exception> theHandler) { @@ -192,7 +192,7 @@ public class DefaultRemoteManagerImplementation implements RemoteManager { } /** - * Returns my identifier + * Returns my identifier. */ @Override public RemoteIdentifier getMyIdentifier() { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteMessage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteMessage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteMessage.java index d2da7f2..7439430 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteMessage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/DefaultRemoteMessage.java @@ -22,7 +22,7 @@ import org.apache.reef.wake.remote.RemoteIdentifier; import org.apache.reef.wake.remote.RemoteMessage; /** - * Default remote message implementation + * Default remote message implementation. * * @param <T> type */ @@ -32,7 +32,7 @@ class DefaultRemoteMessage<T> implements RemoteMessage<T> { private final T message; /** - * Constructs a default remote message + * Constructs a default remote message. * * @param id the remote identifier * @param message the message @@ -43,7 +43,7 @@ class DefaultRemoteMessage<T> implements RemoteMessage<T> { } /** - * Gets the identifier part of this remote message + * Gets the identifier part of this remote message. * * @return the identifier */ @@ -53,7 +53,7 @@ class DefaultRemoteMessage<T> implements RemoteMessage<T> { } /** - * Gets the message part of this remote message + * Gets the message part of this remote message. * * @return the message */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/HandlerContainer.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/HandlerContainer.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/HandlerContainer.java index 4e4d67d..7c5a7af 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/HandlerContainer.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/HandlerContainer.java @@ -32,7 +32,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Main logic to dispatch messages + * Main logic to dispatch messages. */ final class HandlerContainer<T> implements EventHandler<RemoteEvent<byte[]>> { @@ -94,7 +94,7 @@ final class HandlerContainer<T> implements EventHandler<RemoteEvent<byte[]>> { } /** - * Unsubscribes a handler + * Unsubscribes a handler. * * @param subscription * @throws org.apache.reef.wake.remote.exception.RemoteRuntimeException if the Subscription type is unknown @@ -115,7 +115,7 @@ final class HandlerContainer<T> implements EventHandler<RemoteEvent<byte[]>> { } /** - * Dispatches a message + * Dispatches a message. * * @param value */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiCodec.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiCodec.java index e07a1cd..c89d0ca 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiCodec.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiCodec.java @@ -26,7 +26,7 @@ import java.util.HashMap; import java.util.Map; /** - * Codec using the WakeTuple protocol buffer + * Codec using the WakeTuple protocol buffer. * (class name and bytes) * * @param <T> @@ -37,7 +37,7 @@ public class MultiCodec<T> implements Codec<T> { private final Decoder<T> decoder; /** - * Constructs a codec that encodes/decodes an object to/from bytes based on the class name + * Constructs a codec that encodes/decodes an object to/from bytes based on the class name. * * @param clazzToDecoderMap */ @@ -53,7 +53,7 @@ public class MultiCodec<T> implements Codec<T> { } /** - * Encodes an object to a byte array + * Encodes an object to a byte array. * * @param obj */ @@ -63,7 +63,7 @@ public class MultiCodec<T> implements Codec<T> { } /** - * Decodes byte array + * Decodes byte array. * * @param data class name and byte payload */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiDecoder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiDecoder.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiDecoder.java index da84e92..833aa5f 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiDecoder.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiDecoder.java @@ -26,7 +26,7 @@ import org.apache.reef.wake.remote.proto.WakeRemoteProtos.WakeTuplePBuf; import java.util.Map; /** - * Decoder using the WakeTuple protocol buffer + * Decoder using the WakeTuple protocol buffer. * (class name and bytes) * * @param <T> type @@ -35,7 +35,7 @@ public class MultiDecoder<T> implements Decoder<T> { private final Map<Class<? extends T>, Decoder<? extends T>> clazzToDecoderMap; /** - * Constructs a decoder that decodes bytes based on the class name + * Constructs a decoder that decodes bytes based on the class name. * * @param clazzToDecoderMap */ @@ -44,7 +44,7 @@ public class MultiDecoder<T> implements Decoder<T> { } /** - * Decodes byte array + * Decodes byte array. * * @param data class name and byte payload */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiEncoder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiEncoder.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiEncoder.java index 1fbfffe..e8d2a41 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiEncoder.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/MultiEncoder.java @@ -26,7 +26,7 @@ import org.apache.reef.wake.remote.proto.WakeRemoteProtos.WakeTuplePBuf; import java.util.Map; /** - * Encoder using the WakeTuple protocol buffer + * Encoder using the WakeTuple protocol buffer. * (class name and bytes) * * @param <T> @@ -36,7 +36,7 @@ public class MultiEncoder<T> implements Encoder<T> { private final Map<Class<? extends T>, Encoder<? extends T>> clazzToEncoderMap; /** - * Constructs an encoder that encodes an object to bytes based on the class name + * Constructs an encoder that encodes an object to bytes based on the class name. * * @param clazzToDecoderMap */ @@ -45,7 +45,7 @@ public class MultiEncoder<T> implements Encoder<T> { } /** - * Encodes an object to a byte array + * Encodes an object to a byte array. * * @param obj */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ObjectSerializableCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ObjectSerializableCodec.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ObjectSerializableCodec.java index 7c59586..8c073bc 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ObjectSerializableCodec.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ObjectSerializableCodec.java @@ -25,7 +25,7 @@ import javax.inject.Inject; import java.io.*; /** - * Codec that uses Java serialization + * Codec that uses Java serialization. * * @param <T> */ @@ -36,7 +36,7 @@ public class ObjectSerializableCodec<T> implements Codec<T> { } /** - * Encodes the object to bytes + * Encodes the object to bytes. * * @param obj the object * @return bytes @@ -54,7 +54,7 @@ public class ObjectSerializableCodec<T> implements Codec<T> { } /** - * Decodes an object from the bytes + * Decodes an object from the bytes. * * @param buf the bytes * @return an object http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/OrderedRemoteReceiverStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/OrderedRemoteReceiverStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/OrderedRemoteReceiverStage.java index ea34e24..1428caa 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/OrderedRemoteReceiverStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/OrderedRemoteReceiverStage.java @@ -32,7 +32,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Receive incoming events and dispatch to correct handlers in order + * Receive incoming events and dispatch to correct handlers in order. */ public class OrderedRemoteReceiverStage implements EStage<TransportEvent> { @@ -47,7 +47,7 @@ public class OrderedRemoteReceiverStage implements EStage<TransportEvent> { private final ThreadPoolStage<OrderedEventStream> pullStage; /** - * Constructs a ordered remote receiver stage + * Constructs a ordered remote receiver stage. * * @param handler the handler of remote events * @param errorHandler the exception handler http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ProxyEventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ProxyEventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ProxyEventHandler.java index 8083ab8..355c92d 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ProxyEventHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/ProxyEventHandler.java @@ -26,7 +26,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Proxy of the event handler that runs remotely + * Proxy of the event handler that runs remotely. * * @param <T> type */ @@ -40,7 +40,7 @@ public class ProxyEventHandler<T> implements EventHandler<T> { private final RemoteSeqNumGenerator seqGen; /** - * Constructs a proxy event handler + * Constructs a proxy event handler. * * @param myId my identifier * @param remoteId the remote identifier @@ -62,7 +62,7 @@ public class ProxyEventHandler<T> implements EventHandler<T> { } /** - * Sends the event to the event handler running remotely + * Sends the event to the event handler running remotely. * * @param event the event */ @@ -75,7 +75,7 @@ public class ProxyEventHandler<T> implements EventHandler<T> { } /** - * Returns a string representation of the object + * Returns a string representation of the object. * * @return a string representation of the object */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEvent.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEvent.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEvent.java index 135a149..5cec358 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEvent.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEvent.java @@ -21,7 +21,7 @@ package org.apache.reef.wake.remote.impl; import java.net.SocketAddress; /** - * Event that are exchanged across process boundaries + * Event that are exchanged across process boundaries. * * @param <T> type */ @@ -36,7 +36,7 @@ public class RemoteEvent<T> { private String sink; /** - * Constructs a remote event + * Constructs a remote event. * * @param localAddr the local socket address * @param remoteAddr the remote socket address @@ -55,7 +55,7 @@ public class RemoteEvent<T> { } /** - * Gets the local socket address + * Gets the local socket address. * * @return the local socket address */ @@ -64,7 +64,7 @@ public class RemoteEvent<T> { } /** - * Gets the remote socket address + * Gets the remote socket address. * * @return the remote socket address */ @@ -73,7 +73,7 @@ public class RemoteEvent<T> { } /** - * Gets the source + * Gets the source. * * @return the source */ @@ -82,7 +82,7 @@ public class RemoteEvent<T> { } /** - * Sets the source + * Sets the source. * * @param name the source name */ @@ -91,7 +91,7 @@ public class RemoteEvent<T> { } /** - * Gets the sink + * Gets the sink. * * @return the sink */ @@ -100,7 +100,7 @@ public class RemoteEvent<T> { } /** - * Sets the sink + * Sets the sink. * * @param name the sink name */ @@ -109,7 +109,7 @@ public class RemoteEvent<T> { } /** - * Gets the actual event + * Gets the actual event. * * @return the event */ @@ -118,7 +118,7 @@ public class RemoteEvent<T> { } /** - * Gets the sequence number + * Gets the sequence number. * * @return the sequence number */ @@ -127,7 +127,7 @@ public class RemoteEvent<T> { } /** - * Sets the local socket address + * Sets the local socket address. * * @param addr the local socket address */ @@ -136,7 +136,7 @@ public class RemoteEvent<T> { } /** - * Sets the remote socket address + * Sets the remote socket address. * * @param addr the remote socket address */ @@ -145,7 +145,7 @@ public class RemoteEvent<T> { } /** - * Returns a string representation of this object + * Returns a string representation of this object. * * @return a string representation of this object */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventCodec.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventCodec.java index 3d5b237..b55dacc 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventCodec.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventCodec.java @@ -21,7 +21,7 @@ package org.apache.reef.wake.remote.impl; import org.apache.reef.wake.remote.Codec; /** - * Codec of the event sent remotely + * Codec of the event sent remotely. * * @param <T> type */ @@ -31,7 +31,7 @@ public class RemoteEventCodec<T> implements Codec<RemoteEvent<T>> { private final RemoteEventDecoder<T> decoder; /** - * Constructs a remote event codec + * Constructs a remote event codec. * * @param codec the codec for the event */ @@ -41,7 +41,7 @@ public class RemoteEventCodec<T> implements Codec<RemoteEvent<T>> { } /** - * Encodes the remote event object to bytes + * Encodes the remote event object to bytes. * * @param obj the remote event object * @returns bytes @@ -52,7 +52,7 @@ public class RemoteEventCodec<T> implements Codec<RemoteEvent<T>> { } /** - * Decodes a remote event object from the bytes + * Decodes a remote event object from the bytes. * * @param data the byte array * @return a remote event object http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventComparator.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventComparator.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventComparator.java index fd4f73b..33d3bd7 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventComparator.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventComparator.java @@ -21,7 +21,7 @@ package org.apache.reef.wake.remote.impl; import java.util.Comparator; /** - * Comparator for the remote event + * Comparator for the remote event. */ public class RemoteEventComparator<T> implements Comparator<RemoteEvent<T>> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventDecoder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventDecoder.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventDecoder.java index 1029589..ed7dcdc 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventDecoder.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventDecoder.java @@ -24,7 +24,7 @@ import org.apache.reef.wake.remote.exception.RemoteRuntimeException; import org.apache.reef.wake.remote.proto.WakeRemoteProtos.WakeMessagePBuf; /** - * Remote event decoder using the WakeMessage protocol buffer + * Remote event decoder using the WakeMessage protocol buffer. * * @param <T> type */ @@ -33,7 +33,7 @@ public class RemoteEventDecoder<T> implements Decoder<RemoteEvent<T>> { private final Decoder<T> decoder; /** - * Constructs a remote event decoder + * Constructs a remote event decoder. * * @param decoder the decoder of the event */ @@ -42,7 +42,7 @@ public class RemoteEventDecoder<T> implements Decoder<RemoteEvent<T>> { } /** - * Decodes a remote event from the byte array data + * Decodes a remote event from the byte array data. * * @param data the byte array data * @return a remote event object http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventEncoder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventEncoder.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventEncoder.java index 897797a..c33c6ae 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventEncoder.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteEventEncoder.java @@ -24,7 +24,7 @@ import org.apache.reef.wake.remote.exception.RemoteRuntimeException; import org.apache.reef.wake.remote.proto.WakeRemoteProtos.WakeMessagePBuf; /** - * Remote event encoder using the WakeMessage protocol buffer + * Remote event encoder using the WakeMessage protocol buffer. * * @param <T> type */ @@ -33,7 +33,7 @@ public class RemoteEventEncoder<T> implements Encoder<RemoteEvent<T>> { private final Encoder<T> encoder; /** - * Constructs a remote event encoder + * Constructs a remote event encoder. * * @param encoder the encoder of the event */ @@ -42,7 +42,7 @@ public class RemoteEventEncoder<T> implements Encoder<RemoteEvent<T>> { } /** - * Encodes the remote event object to bytes + * Encodes the remote event object to bytes. * * @param obj the remote event * @return bytes http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverEventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverEventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverEventHandler.java index d946eea..bab39e8 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverEventHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverEventHandler.java @@ -24,7 +24,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Remote receiver event handler + * Remote receiver event handler. */ class RemoteReceiverEventHandler implements EventHandler<TransportEvent> { @@ -34,7 +34,7 @@ class RemoteReceiverEventHandler implements EventHandler<TransportEvent> { private final EventHandler<RemoteEvent<byte[]>> handler; /** - * Constructs a remote receiver event handler + * Constructs a remote receiver event handler. * * @param handler the upstream handler */ @@ -44,7 +44,7 @@ class RemoteReceiverEventHandler implements EventHandler<TransportEvent> { } /** - * Handles the event received from a remote node + * Handles the event received from a remote node. * * @param e the event */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverStage.java index 3e42a4d..c1c8f2f 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteReceiverStage.java @@ -33,7 +33,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Receive incoming events and dispatch to correct handlers + * Receive incoming events and dispatch to correct handlers. */ public class RemoteReceiverStage implements EStage<TransportEvent> { @@ -46,7 +46,7 @@ public class RemoteReceiverStage implements EStage<TransportEvent> { private final long shutdownTimeout = WakeParameters.REMOTE_EXECUTOR_SHUTDOWN_TIMEOUT; /** - * Constructs a remote receiver stage + * Constructs a remote receiver stage. * * @param handler the handler of remote events * @param errorHandler the exception handler @@ -64,7 +64,7 @@ public class RemoteReceiverStage implements EStage<TransportEvent> { } /** - * Handles the received event + * Handles the received event. * * @param value the event */ @@ -75,7 +75,7 @@ public class RemoteReceiverStage implements EStage<TransportEvent> { } /** - * Closes the stage + * Closes the stage. */ @Override public void close() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderEventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderEventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderEventHandler.java index 04a96d8..176b7ec 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderEventHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderEventHandler.java @@ -33,7 +33,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Remote sender event handler + * Remote sender event handler. * * @param <T> type */ @@ -48,7 +48,7 @@ class RemoteSenderEventHandler<T> implements EventHandler<RemoteEvent<T>> { private final ExecutorService executor; /** - * Constructs a remote sender event handler + * Constructs a remote sender event handler. * * @param encoder the encoder * @param transport the transport to send events @@ -82,7 +82,7 @@ class RemoteSenderEventHandler<T> implements EventHandler<RemoteEvent<T>> { } /** - * Handles the event to send to a remote node + * Handles the event to send to a remote node. * * @param value the event * @throws RemoteRuntimeException http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderStage.java index 7d7b74d..464119e 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSenderStage.java @@ -47,7 +47,7 @@ public class RemoteSenderStage implements Stage { private final Transport transport; /** - * Constructs a remote sender stage + * Constructs a remote sender stage. * * @param encoder the encoder of the event * @param transport the transport to send events @@ -61,7 +61,7 @@ public class RemoteSenderStage implements Stage { } /** - * Returns a new remote sender event handler + * Returns a new remote sender event handler. * * @return a remote sender event handler */ @@ -70,7 +70,7 @@ public class RemoteSenderStage implements Stage { } /** - * Closes the stage + * Closes the stage. */ @Override public void close() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSeqNumGenerator.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSeqNumGenerator.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSeqNumGenerator.java index 6bb26cf..1ecd4be 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSeqNumGenerator.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/RemoteSeqNumGenerator.java @@ -25,7 +25,7 @@ import java.util.concurrent.atomic.AtomicLong; /** - * Generates the sequence number for remote messages per destination + * Generates the sequence number for remote messages per destination. */ public class RemoteSeqNumGenerator { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/SocketRemoteIdentifier.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/SocketRemoteIdentifier.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/SocketRemoteIdentifier.java index 27c54cf..bde67d0 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/SocketRemoteIdentifier.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/SocketRemoteIdentifier.java @@ -24,14 +24,14 @@ import org.apache.reef.wake.remote.exception.RemoteRuntimeException; import java.net.InetSocketAddress; /** - * Remote identifier based on a socket address + * Remote identifier based on a socket address. */ public class SocketRemoteIdentifier implements RemoteIdentifier { private InetSocketAddress addr; /** - * Constructs a remote identifier + * Constructs a remote identifier. * * @param addr the socket address */ @@ -40,7 +40,7 @@ public class SocketRemoteIdentifier implements RemoteIdentifier { } /** - * Constructs a remote identifier + * Constructs a remote identifier. * * @param str the string representation * @throws RemoteRuntimeException @@ -64,7 +64,7 @@ public class SocketRemoteIdentifier implements RemoteIdentifier { } /** - * Gets the socket address + * Gets the socket address. * * @return the socket address */ @@ -73,7 +73,7 @@ public class SocketRemoteIdentifier implements RemoteIdentifier { } /** - * Returns a hash code for the object + * Returns a hash code for the object. * * @return a hash code value for this object */ @@ -83,7 +83,7 @@ public class SocketRemoteIdentifier implements RemoteIdentifier { } /** - * Checks that another object is equal to this object + * Checks that another object is equal to this object. * * @param o another object * @return true if the object is the same as the object argument; false, otherwise @@ -94,7 +94,7 @@ public class SocketRemoteIdentifier implements RemoteIdentifier { } /** - * Returns a string representation of the object + * Returns a string representation of the object. * * @return a string representation of the object */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/StringCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/StringCodec.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/StringCodec.java index 75fba5b..558e96b 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/StringCodec.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/StringCodec.java @@ -21,12 +21,12 @@ package org.apache.reef.wake.remote.impl; import org.apache.reef.wake.remote.Codec; /** - * Codec that encodes/decodes a string + * Codec that encodes/decodes a string. */ public class StringCodec implements Codec<String> { /** - * Returns a byte array representation of the string + * Returns a byte array representation of the string. * * @param obj the string * @return a byte array representation of the string @@ -37,7 +37,7 @@ public class StringCodec implements Codec<String> { } /** - * Returns a string decoded from the byte array + * Returns a string decoded from the byte array. * * @param buf the byte array * @return a string http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Subscription.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Subscription.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Subscription.java index cd88965..27bdeb6 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Subscription.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Subscription.java @@ -19,7 +19,7 @@ package org.apache.reef.wake.remote.impl; /** - * Subscription of a handler + * Subscription of a handler. * * @param <T> type */ @@ -29,7 +29,7 @@ public class Subscription<T> implements AutoCloseable { private final T token; /** - * Constructs a subscription + * Constructs a subscription. * * @param token the token for finding the subscription * @param handlerContainer the container managing handlers @@ -40,7 +40,7 @@ public class Subscription<T> implements AutoCloseable { } /** - * Gets the token of this subscription + * Gets the token of this subscription. * * @return the token of this subscription */ @@ -49,7 +49,7 @@ public class Subscription<T> implements AutoCloseable { } /** - * Unsubscribes this subscription + * Unsubscribes this subscription. * * @throws Exception */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/TransportEvent.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/TransportEvent.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/TransportEvent.java index d173307..a633bb3 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/TransportEvent.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/TransportEvent.java @@ -24,7 +24,7 @@ import java.net.SocketAddress; /** - * Event sent from a remote node + * Event sent from a remote node. */ public class TransportEvent { private final byte[] data; @@ -33,7 +33,7 @@ public class TransportEvent { private final Link<byte[]> link; /** - * Constructs an object event + * Constructs an object event. * * @param data the data * @param localAddr the local socket address @@ -47,7 +47,7 @@ public class TransportEvent { } /** - * Constructs the transport even object using link to + * Constructs the transport even object using link to. * initialize local and remote address if link not null * * @param data @@ -66,7 +66,7 @@ public class TransportEvent { } /** - * Gets the data + * Gets the data. * * @return data */ @@ -75,7 +75,7 @@ public class TransportEvent { } /** - * Returns the link associated with the event + * Returns the link associated with the event. * which can be used to write back to the client * without creating a new link * @@ -86,7 +86,7 @@ public class TransportEvent { } /** - * Gets the local socket address + * Gets the local socket address. * * @return the local socket address */ @@ -95,7 +95,7 @@ public class TransportEvent { } /** - * Gets the remote socket address + * Gets the remote socket address. * * @return the remote socket address */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Tuple2.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Tuple2.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Tuple2.java index cd76e30..bf235de 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Tuple2.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/impl/Tuple2.java @@ -19,7 +19,7 @@ package org.apache.reef.wake.remote.impl; /** - * Tuple with two values + * Tuple with two values. * * @param <T1> * @param <T2> @@ -56,4 +56,4 @@ public class Tuple2<T1, T2> { public String toString() { return t1.toString() + " " + t2.toString(); } -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RandomRangeIterator.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RandomRangeIterator.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RandomRangeIterator.java index dbb47c4..9b177ad 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RandomRangeIterator.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RandomRangeIterator.java @@ -24,7 +24,7 @@ import java.util.Iterator; import java.util.Random; /** - * This class will give out random port numbers between tcpPortRangeBegin and tcpPortRangeBegin+tcpPortRangeCount + * This class will give out random port numbers between tcpPortRangeBegin and tcpPortRangeBegin+tcpPortRangeCount. * Max number of ports given is tryCount */ @ThreadSafe @@ -52,7 +52,7 @@ final class RandomRangeIterator implements Iterator<Integer> { } /** - * always throws + * always throws. * @throws UnsupportedOperationException always. */ @Override http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RangeTcpPortProvider.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RangeTcpPortProvider.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RangeTcpPortProvider.java index 246270b..a6196fb 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RangeTcpPortProvider.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/remote/ports/RangeTcpPortProvider.java @@ -33,7 +33,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A TcpPortProvider which gives out random ports in a range + * A TcpPortProvider which gives out random ports in a range. */ public final class RangeTcpPortProvider implements TcpPortProvider { private final int portRangeBegin; @@ -52,7 +52,7 @@ public final class RangeTcpPortProvider implements TcpPortProvider { } /** - * Returns an iterator over a set of tcp ports + * Returns an iterator over a set of tcp ports. * * @return an Iterator. */
