You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by ma...@apache.org on 2015/11/06 21:50:02 UTC
[4/4] incubator-reef git commit: [REEF-912] Make Javadoc-generation
work with Java 8
[REEF-912] Make Javadoc-generation work with Java 8
This PR fixes the followings in order to get Javadoc results:
* Upgrade maven-javadoc-plugin version from 2.10.1 to 2.10.3.
* Correct broken '@throws', '@links', and '@param' tags.
* Add missing '@param'.
* Use '@code' syntax for code snipet: e.g. {@code EventHandler<DriverMessage>}.
* Replace '<p/>' with '<p>' and '&' with 'and'.
* Fix usages of '@see' and use <a> tag for hyperlinks.
JIRA:
[REEF-912](https://issues.apache.org/jira/browse/REEF-912)
Pull Request:
This closes #614
Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/0a5c90cd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/0a5c90cd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/0a5c90cd
Branch: refs/heads/master
Commit: 0a5c90cd38c8f4582a39d40dfc69234e8412ac2f
Parents: f288694
Author: Dongjoon Hyun <do...@apache.org>
Authored: Mon Nov 2 04:11:08 2015 +0900
Committer: Mariia Mykhailova <ma...@apache.org>
Committed: Fri Nov 6 12:47:13 2015 -0800
----------------------------------------------------------------------
.../vortex/common/TaskletExecutionRequest.java | 2 +-
.../reef/vortex/common/VortexRequest.java | 2 +-
.../apache/reef/vortex/common/WorkerReport.java | 2 +-
.../reef/vortex/evaluator/VortexWorker.java | 2 +-
...ocalRuntimeDriverConfigurationGenerator.java | 2 +-
.../bridge/client/LocalSubmissionFromCS.java | 4 +-
.../bridge/client/YarnJobSubmissionClient.java | 2 +-
.../bridge/client/YarnSubmissionFromCS.java | 2 +-
.../util/logging/CLRBufferedLogHandler.java | 6 +-
.../reef/io/checkpoint/CheckpointService.java | 6 +-
.../apache/reef/client/DriverConfiguration.java | 2 +-
.../org/apache/reef/client/DriverLauncher.java | 6 +-
.../reef/client/DriverServiceConfiguration.java | 2 +-
.../main/java/org/apache/reef/client/REEF.java | 4 +-
.../reef/driver/ContextAndTaskSubmittable.java | 8 +--
.../reef/driver/FlexiblePreemptionEvent.java | 4 +-
.../org/apache/reef/driver/PreemptionEvent.java | 4 +-
.../reef/driver/StrictPreemptionEvent.java | 2 +-
.../reef/driver/catalog/ResourceCatalog.java | 4 +-
.../reef/driver/client/JobMessageObserver.java | 2 +-
.../reef/driver/context/ActiveContext.java | 6 +-
.../reef/driver/context/FailedContext.java | 2 +-
.../driver/evaluator/AllocatedEvaluator.java | 4 +-
.../reef/driver/evaluator/EvaluatorRequest.java | 28 ++++++++--
.../restart/DriverRuntimeRestartManager.java | 4 +-
.../org/apache/reef/driver/task/FailedTask.java | 4 +-
.../apache/reef/exception/DriverException.java | 2 +-
.../exception/evaluator/ServiceException.java | 2 +-
.../java/org/apache/reef/io/ExternalMap.java | 4 +-
.../src/main/java/org/apache/reef/io/Spool.java | 5 +-
.../org/apache/reef/io/TempFileCreator.java | 16 +++---
.../org/apache/reef/io/naming/NamingLookup.java | 4 +-
.../java/org/apache/reef/io/package-info.java | 3 +-
.../io/serialization/SerializableCodec.java | 2 +-
.../reef/runtime/common/REEFLauncher.java | 3 +-
.../DriverRuntimeRestartConfiguration.java | 2 +-
.../driver/DriverRuntimeStartHandler.java | 2 +-
.../common/driver/api/ResourceLaunchEvent.java | 2 +-
.../common/driver/api/ResourceReleaseEvent.java | 2 +-
.../common/driver/api/ResourceRequestEvent.java | 2 +-
.../driver/api/ResourceRequestEventImpl.java | 18 +++---
.../driver/evaluator/EvaluatorManager.java | 8 +--
.../common/driver/evaluator/Evaluators.java | 2 +-
.../resourcemanager/NodeDescriptorEvent.java | 2 +-
.../ResourceAllocationEvent.java | 2 +-
.../resourcemanager/ResourceStatusEvent.java | 2 +-
.../resourcemanager/RuntimeStatusEvent.java | 2 +-
.../evaluator/context/ContextManager.java | 2 +-
.../evaluator/context/ContextRuntime.java | 10 ++--
.../evaluator/context/RootContextLauncher.java | 2 +-
.../parameters/ApplicationIdentifier.java | 2 +-
.../task/defaults/DefaultCloseHandler.java | 2 +-
.../defaults/DefaultDriverMessageHandler.java | 2 +-
.../runtime/common/files/REEFFileNames.java | 2 +-
.../launch/REEFUncaughtExceptionHandler.java | 4 +-
.../reef/task/HeartBeatTriggerManager.java | 5 +-
.../main/java/org/apache/reef/task/Task.java | 4 +-
.../org/apache/reef/task/TaskMessageSource.java | 2 +-
.../java/org/apache/reef/util/BuilderUtils.java | 3 +
.../org/apache/reef/util/CollectionUtils.java | 3 +-
.../org/apache/reef/util/EnvironmentUtils.java | 3 +-
.../java/org/apache/reef/util/Exceptions.java | 4 +-
.../reef/util/logging/ThreadLogFormatter.java | 6 +-
.../examples/data/loading/package-info.java | 4 +-
.../reef/examples/group/bgd/BGDClient.java | 1 -
.../reef/examples/group/bgd/data/Example.java | 2 +-
.../examples/group/bgd/data/package-info.java | 2 +-
.../group/bgd/data/parser/package-info.java | 2 +-
.../examples/group/bgd/loss/package-info.java | 2 +-
.../reef/examples/group/bgd/package-info.java | 2 +-
.../group/bgd/parameters/package-info.java | 2 +-
.../examples/group/bgd/utils/package-info.java | 2 +-
.../examples/group/broadcast/package-info.java | 2 +-
.../broadcast/parameters/package-info.java | 2 +-
.../group/utils/math/AbstractVector.java | 2 +-
.../reef/examples/group/utils/math/Window.java | 4 +-
.../examples/group/utils/math/package-info.java | 2 +-
.../group/utils/timer/package-info.java | 2 +-
.../reef/examples/library/package-info.java | 2 +-
.../reef/examples/suspend/SuspendClient.java | 2 +-
.../reef/examples/utils/wake/package-info.java | 2 +-
.../reef/io/data/loading/api/DataLoader.java | 2 +-
.../reef/io/data/loading/api/DataSet.java | 4 +-
.../api/EvaluatorToPartitionStrategy.java | 2 +-
.../reef/io/data/loading/api/package-info.java | 2 +-
.../AbstractEvaluatorToPartitionStrategy.java | 2 +-
.../data/loading/impl/InputFormatDataSet.java | 2 +-
.../loading/impl/InputFormatLoadingService.java | 6 +-
.../io/data/loading/impl/NumberedSplit.java | 2 +-
.../data/loading/impl/WritableSerializer.java | 2 +-
.../reef/io/data/loading/impl/package-info.java | 2 +-
.../io/network/NetworkConnectionService.java | 22 ++++----
.../reef/io/network/exception/package-info.java | 2 +-
.../network/group/api/config/OperatorSpec.java | 2 +-
.../api/driver/CommunicationGroupDriver.java | 2 +-
.../group/api/driver/TaskNodeStatus.java | 2 +-
.../network/group/api/operators/AllGather.java | 2 +-
.../network/group/api/operators/Broadcast.java | 4 +-
.../io/network/group/api/operators/Gather.java | 2 +-
.../io/network/group/api/operators/Reduce.java | 2 +-
.../group/api/operators/ReduceScatter.java | 6 +-
.../io/network/group/api/operators/Scatter.java | 2 +-
.../group/api/operators/package-info.java | 6 +-
.../reef/io/network/group/api/package-info.java | 2 +-
.../network/group/api/task/GroupCommClient.java | 2 +-
.../io/network/group/api/task/NodeStruct.java | 4 +-
.../group/api/task/OperatorTopology.java | 10 ++--
.../group/api/task/OperatorTopologyStruct.java | 2 +-
.../driver/CommunicationGroupDriverImpl.java | 2 +-
.../group/impl/driver/GroupCommDriverImpl.java | 4 +-
.../group/impl/driver/TaskNodeStatusImpl.java | 2 +-
.../network/group/impl/driver/package-info.java | 2 +-
.../io/network/group/impl/package-info.java | 2 +-
.../group/impl/task/OperatorTopologyImpl.java | 12 ++--
.../impl/task/OperatorTopologyStructImpl.java | 2 +-
.../group/impl/utils/ConcurrentCountingMap.java | 2 +-
.../io/network/group/impl/utils/SetMap.java | 2 +-
.../reef/io/storage/local/package-info.java | 2 +-
.../apache/reef/io/storage/package-info.java | 2 +-
.../apache/reef/io/storage/ram/RamSpool.java | 2 +-
.../reef/io/storage/ram/package-info.java | 2 +-
.../reef/io/storage/util/package-info.java | 2 +-
.../client/HDInsightDriverConfiguration.java | 6 +-
.../UnsafeHDInsightRuntimeConfiguration.java | 2 +-
.../client/sslhacks/UnsafeTrustManager.java | 2 +-
.../TestHDInsightRESTJsonSerialization.java | 4 +-
.../runtime/local/LocalClasspathProvider.java | 2 +-
.../reef/runtime/local/client/DriverFiles.java | 4 +-
.../reef/runtime/local/client/FileSet.java | 4 +-
.../local/client/LocalRuntimeConfiguration.java | 2 +-
.../reef/runtime/local/client/package-info.java | 2 +-
.../reef/runtime/local/driver/Container.java | 2 +-
.../runtime/local/driver/ResourceManager.java | 2 +-
.../reef/runtime/mesos/client/package-info.java | 2 +-
.../mesos/client/parameters/package-info.java | 2 +-
.../mesos/driver/MesosDriverConfiguration.java | 2 +-
.../reef/runtime/mesos/driver/package-info.java | 2 +-
.../mesos/driver/parameters/package-info.java | 2 +-
.../runtime/mesos/evaluator/package-info.java | 2 +-
.../evaluator/parameters/package-info.java | 2 +-
.../apache/reef/runtime/mesos/package-info.java | 2 +-
.../reef/runtime/mesos/util/package-info.java | 2 +-
.../reef/runtime/yarn/ClassPathBuilder.java | 2 +-
.../yarn/client/YarnSubmissionHelper.java | 6 +-
.../reef/runtime/yarn/client/package-info.java | 2 +-
.../yarn/client/parameters/JobPriority.java | 2 +-
.../yarn/client/parameters/package-info.java | 2 +-
.../runtime/yarn/client/uploader/JobFolder.java | 4 +-
.../yarn/client/uploader/JobUploader.java | 4 +-
.../yarn/client/uploader/package-info.java | 2 +-
.../yarn/driver/DefaultRackNameFormatter.java | 2 +-
.../yarn/driver/YarnDriverConfiguration.java | 8 +--
.../driver/YarnDriverRestartConfiguration.java | 2 +-
.../driver/YarnDriverRuntimeRestartManager.java | 2 +-
.../yarn/driver/parameters/package-info.java | 2 +-
.../apache/reef/runtime/yarn/package-info.java | 2 +-
.../reef/runtime/yarn/util/package-info.java | 2 +-
.../main/java/org/apache/reef/tang/Aspect.java | 10 +++-
.../java/org/apache/reef/tang/BindLocation.java | 2 +-
.../org/apache/reef/tang/ClassHierarchy.java | 17 ++++--
.../reef/tang/ClassHierarchySerializer.java | 6 ++
.../org/apache/reef/tang/Configuration.java | 36 ++++++++----
.../apache/reef/tang/ConfigurationBuilder.java | 58 ++++++++++++--------
.../org/apache/reef/tang/Configurations.java | 4 +-
.../org/apache/reef/tang/InjectionFuture.java | 18 +++---
.../java/org/apache/reef/tang/Injector.java | 54 +++++++++++-------
.../apache/reef/tang/JavaClassHierarchy.java | 6 +-
.../reef/tang/JavaConfigurationBuilder.java | 28 ++++++----
.../main/java/org/apache/reef/tang/Tang.java | 32 +++++++++--
.../tang/annotations/DefaultImplementation.java | 4 +-
.../org/apache/reef/tang/annotations/Unit.java | 6 +-
.../reef/tang/exceptions/BindException.java | 2 +-
.../tang/exceptions/InjectionException.java | 2 +-
.../reef/tang/exceptions/ParseException.java | 2 +-
.../formats/AvroConfigurationSerializer.java | 16 +++---
.../apache/reef/tang/formats/CommandLine.java | 15 +++--
.../reef/tang/formats/ConfigurationModule.java | 18 +++---
.../formats/ConfigurationModuleBuilder.java | 3 +
.../tang/formats/ConfigurationSerializer.java | 16 +++---
.../reef/tang/implementation/InjectionPlan.java | 8 +--
.../avro/AvroClassHierarchySerializer.java | 2 +
.../implementation/java/ClassHierarchyImpl.java | 2 +-
.../tang/implementation/java/InjectorImpl.java | 10 ++--
.../java/JavaConfigurationBuilderImpl.java | 2 +-
.../types/ConstructorDefImpl.java | 2 +-
.../reef/tang/util/ReflectionUtilities.java | 34 +++++++-----
.../walk/graphviz/GraphvizConfigVisitor.java | 6 +-
.../graphviz/GraphvizInjectionPlanVisitor.java | 2 +-
.../reef/tests/evaluatorreuse/package-info.java | 2 +-
.../reef/tests/fail/driver/package-info.java | 2 +-
.../reef/tests/library/driver/package-info.java | 2 +-
.../tests/library/exceptions/package-info.java | 2 +-
.../reef/tests/library/tasks/package-info.java | 2 +-
.../org/apache/reef/tests/package-info.java | 2 +-
.../reef/tests/rack/awareness/package-info.java | 2 +-
.../reef/tests/statepassing/package-info.java | 2 +-
.../reef/tests/yarn/failure/package-info.java | 2 +-
.../org/apache/reef/tests/TestEnvironment.java | 2 +-
.../reef/tests/files/FileResourceTest.java | 2 +-
.../org/apache/reef/wake/AbstractEStage.java | 6 +-
.../reef/wake/examples/p2p/Pull2Push.java | 4 +-
.../reef/wake/impl/BlockingEventHandler.java | 2 +-
.../wake/impl/BlockingSignalEventHandler.java | 2 +-
.../wake/impl/DefaultIdentifierFactory.java | 2 +-
.../apache/reef/wake/impl/ForkPoolStage.java | 6 +-
.../reef/wake/impl/MergingEventHandler.java | 2 +-
.../reef/wake/impl/MultiEventHandler.java | 2 +-
.../reef/wake/impl/PubSubEventHandler.java | 2 +-
.../org/apache/reef/wake/impl/SyncStage.java | 4 +-
.../apache/reef/wake/impl/ThreadPoolStage.java | 2 -
.../org/apache/reef/wake/impl/TimerStage.java | 2 +-
.../reef/wake/metrics/UniformHistogram.java | 2 +-
.../apache/reef/wake/remote/RemoteManager.java | 12 ++--
.../reef/wake/remote/RemoteManagerFactory.java | 2 +-
.../reef/wake/remote/impl/RemoteEventCodec.java | 2 +-
.../wake/remote/ports/RangeTcpPortProvider.java | 4 +-
.../netty/ChunkedReadWriteHandler.java | 8 +--
.../wake/remote/transport/netty/NettyLink.java | 2 +-
.../apache/reef/wake/rx/AbstractRxStage.java | 4 +-
.../java/org/apache/reef/wake/rx/Subject.java | 6 +-
.../exception/ObserverCompletedException.java | 2 +-
.../reef/wake/rx/impl/RxThreadPoolStage.java | 8 +--
.../reef/wake/rx/impl/TimeoutSubject.java | 4 +-
.../org/apache/reef/webserver/HttpHandler.java | 6 +-
.../reef/webserver/ParsedHttpRequest.java | 1 -
pom.xml | 2 +-
226 files changed, 598 insertions(+), 480 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/TaskletExecutionRequest.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/TaskletExecutionRequest.java b/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/TaskletExecutionRequest.java
index 2c60c8a..c540572 100644
--- a/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/TaskletExecutionRequest.java
+++ b/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/TaskletExecutionRequest.java
@@ -42,7 +42,7 @@ public final class TaskletExecutionRequest<TInput extends Serializable, TOutput
}
/**
- * Vortex Master -> Vortex Worker request to execute a tasklet.
+ * Request from Vortex Master to Vortex Worker to execute a tasklet.
*/
public TaskletExecutionRequest(final int taskletId,
final VortexFunction<TInput, TOutput> userFunction,
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/VortexRequest.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/VortexRequest.java b/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/VortexRequest.java
index 967ab98..51061c2 100644
--- a/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/VortexRequest.java
+++ b/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/VortexRequest.java
@@ -23,7 +23,7 @@ import org.apache.reef.annotations.Unstable;
import java.io.Serializable;
/**
- * Master -> Worker protocol.
+ * Master-to-Worker protocol.
*/
@Unstable
public interface VortexRequest extends Serializable {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/WorkerReport.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/WorkerReport.java b/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/WorkerReport.java
index 4444f3c..7e320cb 100644
--- a/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/WorkerReport.java
+++ b/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/common/WorkerReport.java
@@ -23,7 +23,7 @@ import org.apache.reef.annotations.Unstable;
import java.io.Serializable;
/**
- * Worker -> Master protocol.
+ * Worker-to-Master protocol.
*/
@Unstable
public interface WorkerReport extends Serializable {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/evaluator/VortexWorker.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/evaluator/VortexWorker.java b/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/evaluator/VortexWorker.java
index 86906c1..6a2821e 100644
--- a/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/evaluator/VortexWorker.java
+++ b/lang/java/reef-applications/reef-vortex/src/main/java/org/apache/reef/vortex/evaluator/VortexWorker.java
@@ -63,7 +63,7 @@ public final class VortexWorker implements Task, TaskMessageSource {
}
/**
- * Starts the scheduler & executor and waits until termination.
+ * Starts the scheduler and executor and waits until termination.
*/
@Override
public byte[] call(final byte[] memento) throws Exception {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalRuntimeDriverConfigurationGenerator.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalRuntimeDriverConfigurationGenerator.java b/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalRuntimeDriverConfigurationGenerator.java
index 6d8f931..5aa04a6 100644
--- a/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalRuntimeDriverConfigurationGenerator.java
+++ b/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalRuntimeDriverConfigurationGenerator.java
@@ -63,7 +63,7 @@ final class LocalRuntimeDriverConfigurationGenerator {
* @param jobFolder The folder in which the job is staged.
* @param jobId id of the job to be submitted
* @param clientRemoteId
- * @return
+ * @return the configuration
* @throws IOException
*/
public Configuration writeConfiguration(final File jobFolder,
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalSubmissionFromCS.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalSubmissionFromCS.java b/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalSubmissionFromCS.java
index 691a39c..a5a80d5 100644
--- a/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalSubmissionFromCS.java
+++ b/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/LocalSubmissionFromCS.java
@@ -37,7 +37,7 @@ import java.util.ArrayList;
/**
* Represents a job submission from the CS code.
- * <p/>
+ * <p>
* This class exists mostly to parse and validate the command line parameters provided by the C# class
* `Org.Apache.REEF.Client.Local.LocalClient`
*/
@@ -131,7 +131,7 @@ final class LocalSubmissionFromCS {
/**
* Gets parameters from C#:
- * <p/>
+ * <p>
* args[0]: Driver folder.
* args[1]: Job ID.
* args[2]: Number of Evaluators.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnJobSubmissionClient.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnJobSubmissionClient.java b/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnJobSubmissionClient.java
index 843f677..fbd7abc 100644
--- a/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnJobSubmissionClient.java
+++ b/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnJobSubmissionClient.java
@@ -95,7 +95,7 @@ public final class YarnJobSubmissionClient {
/**
* @param driverFolder the folder containing the `reef` folder. Only that `reef` folder will be in the JAR.
- * @return
+ * @return the jar file
* @throws IOException
*/
private File makeJar(final File driverFolder) throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnSubmissionFromCS.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnSubmissionFromCS.java b/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnSubmissionFromCS.java
index 9b4c35b..3b38786 100644
--- a/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnSubmissionFromCS.java
+++ b/lang/java/reef-bridge-client/src/main/java/org/apache/reef/bridge/client/YarnSubmissionFromCS.java
@@ -39,7 +39,7 @@ import java.util.List;
/**
* Represents a job submission from the CS code.
- * <p/>
+ * <p>
* This class exists mostly to parse and validate the command line parameters provided by the C# class
* `Org.Apache.REEF.Client.YARN.YARNClient`
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRBufferedLogHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRBufferedLogHandler.java b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRBufferedLogHandler.java
index 1296ac1..4004cf4 100644
--- a/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRBufferedLogHandler.java
+++ b/lang/java/reef-bridge-java/src/main/java/org/apache/reef/util/logging/CLRBufferedLogHandler.java
@@ -32,7 +32,7 @@ import java.util.logging.SimpleFormatter;
/**
* Logging Handler to intercept java logs and transfer them
* to the CLR side via the reef-bridge.
- * <p/>
+ * <p>
* Logs are buffered to avoid the cost of reef-bridge function calls.
* A thread is also scheduled to flush the log buffer at a certain interval,
* in case the log buffer remains unfilled for an extended period of time.
@@ -68,7 +68,7 @@ public class CLRBufferedLogHandler extends Handler {
/**
* Called whenever a log message is received on the java side.
- * <p/>
+ * <p>
* Adds the log record to the log buffer. If the log buffer is full and
* the driver has already been initialized, flush the buffer of the logs.
*/
@@ -110,7 +110,7 @@ public class CLRBufferedLogHandler extends Handler {
/**
* Starts a thread to flush the log buffer on an interval.
- * <p/>
+ * <p>
* This will ensure that logs get flushed periodically, even
* if the log buffer is not full.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/CheckpointService.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/CheckpointService.java b/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/CheckpointService.java
index 849e770..d776665 100644
--- a/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/CheckpointService.java
+++ b/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/CheckpointService.java
@@ -24,14 +24,14 @@ import java.nio.channels.WritableByteChannel;
/**
* The CheckpointService provides a simple API to store and retrieve the state of a task.
- * <p/>
+ * <p>
* Checkpoints are atomic, single-writer, write-once, multiple-readers, ready-many type of objects.
* This is provided by releasing the CheckpointID for a checkpoint only upon commit of the checkpoint,
* and by preventing a checkpoint to be re-opened for writes.
- * <p/>
+ * <p>
* Non-functional properties such as durability, availability, compression, garbage collection,
* quotas are left to the implementation.
- * <p/>
+ * <p>
* This API is envisioned as the basic building block for a checkpoint service, on top of which richer
* interfaces can be layered (e.g., frameworks providing object-serialization, checkpoint metadata and
* provenance, etc.)
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverConfiguration.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverConfiguration.java b/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverConfiguration.java
index 6dc9c55..a566475 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverConfiguration.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverConfiguration.java
@@ -178,7 +178,7 @@ public final class DriverConfiguration extends ConfigurationModuleBuilder {
public static final OptionalImpl<EventHandler<ContextMessage>> ON_CONTEXT_MESSAGE = new OptionalImpl<>();
/**
- * @see {@link ProgressProvider}
+ * Progress provider. See {@link ProgressProvider}.
*/
public static final OptionalImpl<ProgressProvider> PROGRESS_PROVIDER = new OptionalImpl<>();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverLauncher.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverLauncher.java b/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverLauncher.java
index 8ee8aa5..55bc1ad 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverLauncher.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverLauncher.java
@@ -35,11 +35,11 @@ import java.util.logging.Logger;
/**
* A launcher for REEF Drivers.
- * <p/>
+ * <p>
* It can be instantiated using a configuration that can create a REEF instance.
* For example, the local resourcemanager and the YARN resourcemanager can do this.
- * <p/>
- * {@see org.apache.reef.examples.hello.HelloREEF} for a demo use case.
+ * <p>
+ * See {@link org.apache.reef.examples.hello} package for a demo use case.
*/
@Public
@Provided
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverServiceConfiguration.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverServiceConfiguration.java b/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverServiceConfiguration.java
index 8ac1519..aa6c2a8 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverServiceConfiguration.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/client/DriverServiceConfiguration.java
@@ -39,7 +39,7 @@ import org.apache.reef.wake.time.event.StopTime;
/**
* Use this ConfigurationModule to configure Services to be run in the Driver.
- * <p/>
+ * <p>
* A service is a set of event handlers that are informed of events in addition to * the event handlers defined in
* DriverConfiguration. However, most services will treat the events as read-only. Doing differently should be
* documented clearly in the Service documentation.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/client/REEF.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/client/REEF.java b/lang/java/reef-common/src/main/java/org/apache/reef/client/REEF.java
index c1e891c..3adc031 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/client/REEF.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/client/REEF.java
@@ -26,7 +26,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation;
/**
* The main entry point into the REEF resourcemanager.
- * <p/>
+ * <p>
* Every REEF resourcemanager provides an implementation of this interface. That
* instance is used to submitTask the Driver class for execution to REEF. As with
* all submissions in REEF, this is done in the form of a TANG Configuration
@@ -45,7 +45,7 @@ public interface REEF extends AutoCloseable {
/**
* Submits the Driver set up in the given Configuration for execution.
- * <p/>
+ * <p>
* The Configuration needs to bind the Driver interface to an actual
* implementation of that interface for the job at hand.
*
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/ContextAndTaskSubmittable.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/ContextAndTaskSubmittable.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/ContextAndTaskSubmittable.java
index d5d816a..cb0581a 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/ContextAndTaskSubmittable.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/ContextAndTaskSubmittable.java
@@ -32,11 +32,11 @@ import org.apache.reef.tang.Configuration;
public interface ContextAndTaskSubmittable {
/**
* Submit a Context and a Task.
- * <p/>
+ * <p>
* The semantics of this call are the same as first submitting the context and then, on the fired ActiveContext event
* to submit the Task. The performance of this will be better, though as it potentially saves some roundtrips on
* the network.
- * <p/>
+ * <p>
* REEF will not fire an ActiveContext as a result of this. Instead, it will fire a TaskRunning event.
*
* @param contextConfiguration the Configuration of the EvaluatorContext. See ContextConfiguration for details.
@@ -46,11 +46,11 @@ public interface ContextAndTaskSubmittable {
/**
* Submit a Context with Services and a Task.
- * <p/>
+ * <p>
* The semantics of this call are the same as first submitting the context and services and then, on the fired
* ActiveContext event to submit the Task. The performance of this will be better, though as it potentially saves
* some roundtrips on the network.
- * <p/>
+ * <p>
* REEF will not fire an ActiveContext as a result of this. Instead, it will fire a TaskRunning event.
*
* @param contextConfiguration
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/FlexiblePreemptionEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/FlexiblePreemptionEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/FlexiblePreemptionEvent.java
index b94c852..f5b7003 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/FlexiblePreemptionEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/FlexiblePreemptionEvent.java
@@ -27,12 +27,12 @@ import java.util.Set;
/**
* Represents a flexible preemption request: It contains:
- * <p/>
+ * <p>
* <ol>
* <li>a set of EvaluatorRequests that the resource manager wants to have satisfied and also</li>
* <li>a set of Evaluators it will choose to kill if the request isn't satisfied otherwise.</li>
* </ol>
- * <p/>
+ * <p>
* NOTE: This currently not implemented. Consider it a preview of the API.
*/
@Private
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/PreemptionEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/PreemptionEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/PreemptionEvent.java
index 1fc73ae..331a93d 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/PreemptionEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/PreemptionEvent.java
@@ -25,11 +25,11 @@ import org.apache.reef.annotations.audience.Public;
/**
* Represents Preemption requests issued by the underlying resource manager.
- * <p/>
+ * <p>
* REEF exposes two kinds of preemption requests: Strict ones merely inform the Driver about machines that are about to
* be preempted. Flexible ones provide that list, but also expose the resource request that the underlying resource
* manager wants to satisfy, thereby giving the Driver a chance to satisfy it in another way.
- * <p/>
+ * <p>
* NOTE: This currently not implemented. Consider it a preview of the API.
*/
@DriverSide
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/StrictPreemptionEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/StrictPreemptionEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/StrictPreemptionEvent.java
index 43bca04..05ff8e6 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/StrictPreemptionEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/StrictPreemptionEvent.java
@@ -26,7 +26,7 @@ import org.apache.reef.annotations.audience.Public;
/**
* Represents a strict preemption event: It contains the set of Evaluators that the underlying resource manager will
* take away from the Driver.
- * <p/>
+ * <p>
* NOTE: This currently not implemented. Consider it a preview of the API.
*/
@Unstable
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/catalog/ResourceCatalog.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/catalog/ResourceCatalog.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/catalog/ResourceCatalog.java
index d238474..e4da53e 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/catalog/ResourceCatalog.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/catalog/ResourceCatalog.java
@@ -24,10 +24,10 @@ import java.util.Collection;
/**
* A catalog of the resources available to a REEF instance.
- * <p/>
+ * <p>
* This catalog contains static information about the resources and does not
* reflect that dynamic availability of resources. In other words: Its entries
- * are an upper bound to what is available to a REEF {@link Driver} at any given
+ * are an upper bound to what is available to a REEF Driver at any given
* moment in time.
*/
@Unstable
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/client/JobMessageObserver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/client/JobMessageObserver.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/client/JobMessageObserver.java
index 66712a3..57296f8 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/client/JobMessageObserver.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/client/JobMessageObserver.java
@@ -25,7 +25,7 @@ import org.apache.reef.annotations.audience.Public;
/**
* The driver uses this interface to communicate with the job client.
- * <p/>
+ * <p>
* Note that as of REEF 0.4, the presence of a client is no longer guaranteed, depending on the deployment environment.
*/
@Public
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/ActiveContext.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/ActiveContext.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/ActiveContext.java
index b608011..7bc031e 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/ActiveContext.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/ActiveContext.java
@@ -28,16 +28,16 @@ import org.apache.reef.tang.Configuration;
/**
* Represents an active context on an Evaluator.
- * <p/>
+ * <p>
* A context consists of two configurations:
* <ol>
* <li>ContextConfiguration: Its visibility is limited to the context itself and tasks spawned from it.</li>
* <li>ServiceConfiguration: This is "inherited" by child context spawned.</li>
* </ol>
- * <p/>
+ * <p>
* Contexts have identifiers. A context is instantiated on a single Evaluator. Contexts are either created on an
* AllocatedEvaluator (for what is called the "root Context") or by forming sub-Contexts.
- * <p/>
+ * <p>
* Contexts form a stack. Only the topmost context is active. Child Contexts or Tasks can be submitted to the
* active Context. Contexts can be closed, in which case their parent becomes active.
* In the case of the root context, closing is equivalent to releasing the Evaluator. A child context "sees" all
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/FailedContext.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/FailedContext.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/FailedContext.java
index 39f6702..e1d8c49 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/FailedContext.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/context/FailedContext.java
@@ -27,7 +27,7 @@ import org.apache.reef.util.Optional;
/**
* Represents Context that failed.
* A typical case would be that its ContextStartHandler threw an exception.
- * <p/>
+ * <p>
* The underlying Evaluator is still accessible and a new context can be established. Note that REEF can't guarantee
* consistency of the Evaluator for all applications. It is up to the application to decide whether it is safe to keep
* using the Evaluator.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/AllocatedEvaluator.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/AllocatedEvaluator.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/AllocatedEvaluator.java
index 499bc52..5d18c0d 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/AllocatedEvaluator.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/AllocatedEvaluator.java
@@ -42,7 +42,6 @@ public interface AllocatedEvaluator
* Puts the given file into the working directory of the Evaluator.
*
* @param file the file to be copied
- * @throws java.io.IOException if the copy fails.
*/
void addFile(final File file);
@@ -50,7 +49,6 @@ public interface AllocatedEvaluator
* Puts the given file into the working directory of the Evaluator and adds it to its classpath.
*
* @param file the file to be copied
- * @throws java.io.IOException if the copy fails.
*/
void addLibrary(final File file);
@@ -75,7 +73,7 @@ public interface AllocatedEvaluator
/**
* Submits the given Task for execution.
- * <p/>
+ * <p>
* This generates a ContextConfiguration for the root context with a generated ID derived from the EvaluatorId.
*
* @param taskConfiguration the Configuration. See TaskConfiguration for details.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/EvaluatorRequest.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/EvaluatorRequest.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/EvaluatorRequest.java
index a4bc100..939d301 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/EvaluatorRequest.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/evaluator/EvaluatorRequest.java
@@ -52,6 +52,8 @@ public final class EvaluatorRequest {
}
/**
+ * Get a new builder.
+ *
* @return a new EvaluatorRequest Builder.
*/
public static Builder newBuilder() {
@@ -59,6 +61,8 @@ public final class EvaluatorRequest {
}
/**
+ * Get a new builder from the existing request.
+ *
* @return a new EvaluatorRequest Builder with settings initialized
* from an existing request.
*/
@@ -85,6 +89,8 @@ public final class EvaluatorRequest {
}
/**
+ * Access the number of memory requested.
+ *
* @return the minimum size of Evaluator requested.
*/
public int getMegaBytes() {
@@ -92,6 +98,8 @@ public final class EvaluatorRequest {
}
/**
+ * Access the preferred node.
+ *
* @return the node names that we prefer the Evaluator to run on
*/
public List<String> getNodeNames() {
@@ -99,6 +107,8 @@ public final class EvaluatorRequest {
}
/**
+ * Access the preferred rack name.
+ *
* @return the rack names that we prefer the Evaluator to run on
*/
public List<String> getRackNames() {
@@ -122,8 +132,8 @@ public final class EvaluatorRequest {
/**
* Pre-populates the builder with the values extracted from the request.
*
- * @param request
- * the request
+ * @param request the request
+ * @return this Builder
*/
private Builder(final EvaluatorRequest request) {
setNumber(request.getNumber());
@@ -138,6 +148,8 @@ public final class EvaluatorRequest {
}
/**
+ * Set the amount of memory.
+ *
* @param megaBytes the amount of megabytes to request for the Evaluator.
* @return this builder
*/
@@ -148,10 +160,10 @@ public final class EvaluatorRequest {
}
/**
- * set number of cores.
+ * Set number of cores.
*
* @param cores the number of cores
- * @return
+ * @return this Builder.
*/
@SuppressWarnings("checkstyle:hiddenfield")
public Builder setNumberOfCores(final int cores) {
@@ -162,7 +174,7 @@ public final class EvaluatorRequest {
/**
* Set the number of Evaluators requested.
*
- * @param n
+ * @param n the number of evaluators
* @return this Builder.
*/
@SuppressWarnings("checkstyle:hiddenfield")
@@ -175,6 +187,9 @@ public final class EvaluatorRequest {
* Adds a node name.It is the preferred location where the evaluator should
* run on. If the node is available, the RM will try to allocate the
* evaluator there
+ *
+ * @param nodeName a preferred node name
+ * @return this Builder.
*/
public Builder addNodeName(final String nodeName) {
this.nodeNames.add(nodeName);
@@ -186,6 +201,9 @@ public final class EvaluatorRequest {
* run on. If the rack is available, the RM will try to allocate the
* evaluator in one of its nodes. The RM will try to match node names first,
* and then fallback to rack names
+ *
+ * @param rackName a preferred rack name
+ * @return this Builder.
*/
public Builder addRackName(final String rackName) {
this.rackNames.add(rackName);
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/restart/DriverRuntimeRestartManager.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/restart/DriverRuntimeRestartManager.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/restart/DriverRuntimeRestartManager.java
index 9d041db..fcf3a08 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/restart/DriverRuntimeRestartManager.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/restart/DriverRuntimeRestartManager.java
@@ -38,9 +38,9 @@ import java.util.Set;
@DefaultImplementation(DefaultDriverRuntimeRestartMangerImpl.class)
public interface DriverRuntimeRestartManager {
/**
- * @return > 0 if the driver has been restarted as reported by the resource manager. 0 otherwise.
+ * @return positive if the driver has been restarted as reported by the resource manager. 0 otherwise.
* Note that this is different from whether the driver is in the process of restarting.
- * This returns > 0 both on when the driver is in the restart process or has already finished restarting.
+ * This returns positive both on when the driver is in the restart process or has already finished restarting.
* The default implementation always returns 0.
*/
int getResubmissionAttempts();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/driver/task/FailedTask.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/driver/task/FailedTask.java b/lang/java/reef-common/src/main/java/org/apache/reef/driver/task/FailedTask.java
index a9fb20e..fcc4fe5 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/driver/task/FailedTask.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/driver/task/FailedTask.java
@@ -59,10 +59,10 @@ public final class FailedTask extends AbstractFailure {
/**
* Access the context the task ran (and crashed) on, if it could be recovered.
- * <p/>
+ * <p>
* An ActiveContext is given when the task fails but the context remains alive.
* On context failure, the context also fails and is surfaced via the FailedContext event.
- * <p/>
+ * <p>
* Note that receiving an ActiveContext here is no guarantee that the context (and evaluator)
* are in a consistent state. Application developers need to investigate the reason available
* via getCause() to make that call.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/exception/DriverException.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/exception/DriverException.java b/lang/java/reef-common/src/main/java/org/apache/reef/exception/DriverException.java
index 1e7d247..679879b 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/exception/DriverException.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/exception/DriverException.java
@@ -21,7 +21,7 @@ package org.apache.reef.exception;
import java.util.concurrent.ExecutionException;
/**
- * Thrown by the {@link Driver} and to the clients of {@link REEF}.
+ * Thrown by the Driver and to the clients of REEF.
*/
public class DriverException extends ExecutionException {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/exception/evaluator/ServiceException.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/exception/evaluator/ServiceException.java b/lang/java/reef-common/src/main/java/org/apache/reef/exception/evaluator/ServiceException.java
index 3f71b2f..6c3d918 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/exception/evaluator/ServiceException.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/exception/evaluator/ServiceException.java
@@ -20,7 +20,7 @@ package org.apache.reef.exception.evaluator;
/**
* The base class for exceptions thrown by REEF libraries and services.
- * <p/>
+ * <p>
* Rules of thumb for exception handling in REEF:
* <ul>
* <li>When possible, throw a subclass of ServiceException, with the following exceptions (no pun intended)</li>
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/io/ExternalMap.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/io/ExternalMap.java b/lang/java/reef-common/src/main/java/org/apache/reef/io/ExternalMap.java
index 6c55780..b71a9af 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/io/ExternalMap.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/io/ExternalMap.java
@@ -64,11 +64,11 @@ public interface ExternalMap<T> {
* removed. (The map can contain at most one such mapping.) Returns the
* value to which this map previously associated the key, or null if the map
* contained no mapping for the key.
- * <p/>
+ * <p>
* If this map permits null values, then a return value of null does not
* necessarily indicate that the map contained no mapping for the key; it's
* also possible that the map explicitly mapped the key to null.
- * <p/>
+ * <p>
* The map will not contain a mapping for the specified key once the call
* returns.
*
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/io/Spool.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/io/Spool.java b/lang/java/reef-common/src/main/java/org/apache/reef/io/Spool.java
index 3dd3f11..f980bb1 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/io/Spool.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/io/Spool.java
@@ -33,21 +33,20 @@ public interface Spool<T> extends Iterable<T>, Accumulable<T> {
/**
* Returns an Iterable over the spool file.
- * <p/>
+ * <p>
* Depending on the implementation, this method may be called only once per
* Spool instance, or it may be called repeatedly. Similarly, with some Spool
* implementations, attempts to append to the SpoolFile after calling
* iterator() may fail fast with a ConcurrentModificationException.
*
* @return An Iterator over the SpoolFile, in the order data was inserted.
- * @throws Exception
*/
@Override
Iterator<T> iterator();
/**
* Returns an Accumulator for the spool file.
- * <p/>
+ * <p>
* Depending on the implementation, this method may be called only once per
* Spool instance, or it may be called repeatedly. Similarly, with some Spool
* implementations, attempts to append to the SpoolFile after calling
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/io/TempFileCreator.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/io/TempFileCreator.java b/lang/java/reef-common/src/main/java/org/apache/reef/io/TempFileCreator.java
index 6027518..d6bc95a 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/io/TempFileCreator.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/io/TempFileCreator.java
@@ -34,9 +34,9 @@ public interface TempFileCreator {
/**
* Creates a temporary file.
*
- * @param prefix
- * @param suffix
- * @return
+ * @param prefix the prefix for the file
+ * @param suffix the suffix for the file
+ * @return the created file.
* @throws IOException
*/
File createTempFile(final String prefix, final String suffix) throws IOException;
@@ -44,9 +44,9 @@ public interface TempFileCreator {
/**
* Creates a temporary folder.
*
- * @param prefix
- * @param attrs
- * @return
+ * @param prefix the prefix for the file
+ * @param attrs the attributes for the file
+ * @return the created folder.
* @throws IOException
*/
File createTempDirectory(final String prefix, final FileAttribute<?> attrs) throws IOException;
@@ -55,8 +55,8 @@ public interface TempFileCreator {
/**
* Create a temporary folder.
*
- * @param prefix
- * @return
+ * @param prefix the prefix for the folder
+ * @return the created folder
* @throws IOException
*/
File createTempDirectory(final String prefix) throws IOException;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/io/naming/NamingLookup.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/io/naming/NamingLookup.java b/lang/java/reef-common/src/main/java/org/apache/reef/io/naming/NamingLookup.java
index 13c912c..0ab4525 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/io/naming/NamingLookup.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/io/naming/NamingLookup.java
@@ -33,8 +33,8 @@ public interface NamingLookup {
/**
* Lookup an Address for a given Identifier.
*
- * @param id
- * @return
+ * @param id the identifier to be searched
+ * @return the Inet address
* @throws java.io.IOException
*/
InetSocketAddress lookup(final Identifier id) throws Exception;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/io/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/io/package-info.java b/lang/java/reef-common/src/main/java/org/apache/reef/io/package-info.java
index c86b7ea..ac3bbb6 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/io/package-info.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/io/package-info.java
@@ -17,7 +17,8 @@
* under the License.
*/
/**
- * APIs for I/O in REEF: {@link org.apache.reef.io.Codec}s and {@link org.apache.reef.io.Serializer}s.
+ * APIs for I/O in REEF: {@link org.apache.reef.io.serialization.Codec}s and
+ * {@link org.apache.reef.io.serialization.Serializer}s.
*/
@Unstable
package org.apache.reef.io;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/io/serialization/SerializableCodec.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/io/serialization/SerializableCodec.java b/lang/java/reef-common/src/main/java/org/apache/reef/io/serialization/SerializableCodec.java
index f0a4394..e0ea1c9 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/io/serialization/SerializableCodec.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/io/serialization/SerializableCodec.java
@@ -24,7 +24,7 @@ import java.util.logging.Logger;
/**
* A {@link Codec} for {@link Serializable} objects.
- * <p/>
+ * <p>
* It uses java serialization, use with caution.
*
* @param <T> The type of objects Serialized
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/REEFLauncher.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/REEFLauncher.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/REEFLauncher.java
index 02a4cdf..878e9b2 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/REEFLauncher.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/REEFLauncher.java
@@ -148,8 +148,7 @@ public final class REEFLauncher {
/**
* Launches a REEF client process (Driver or Evaluator).
*
- * @param args
- * @throws Exception
+ * @param args command-line args
*/
public static void main(final String[] args) {
LOG.log(Level.INFO, "Entering REEFLauncher.main().");
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeRestartConfiguration.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeRestartConfiguration.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeRestartConfiguration.java
index 2f6768a..663704b 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeRestartConfiguration.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeRestartConfiguration.java
@@ -26,7 +26,7 @@ import org.apache.reef.tang.formats.*;
/**
* The base configuration module for driver restart configurations of all runtimes.
- * <p/>
+ * <p>
*/
@Private
@ClientSide
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeStartHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeStartHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeStartHandler.java
index 3421a22..612283f 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeStartHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/DriverRuntimeStartHandler.java
@@ -34,7 +34,7 @@ import java.util.logging.Logger;
/**
* The RuntimeStart handler of the Driver.
- * <p/>
+ * <p>
* This instantiates the DriverSingletons upon construction. Upon onNext(), it sets the resource manager status and
* wires up the remote event handler connections to the client and the evaluators.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceLaunchEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceLaunchEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceLaunchEvent.java
index 735c9f9..592d01c 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceLaunchEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceLaunchEvent.java
@@ -28,7 +28,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation;
import java.util.Set;
/**
- * Event from Driver Process -> Driver Runtime.
+ * Event from Driver Process to Driver Runtime.
* A request to the Driver Runtime to launch an Evaluator on the allocated Resource
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceReleaseEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceReleaseEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceReleaseEvent.java
index 3a23054..30d9464 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceReleaseEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceReleaseEvent.java
@@ -23,7 +23,7 @@ import org.apache.reef.annotations.audience.RuntimeAuthor;
import org.apache.reef.tang.annotations.DefaultImplementation;
/**
- * Event from Driver Process -> Driver Runtime.
+ * Event from Driver Process to Driver Runtime.
* A request to the Driver Runtime to release this resource
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEvent.java
index d27d5f5..8cf8a33 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEvent.java
@@ -26,7 +26,7 @@ import org.apache.reef.util.Optional;
import java.util.List;
/**
- * Event from Driver Process -> Driver Runtime.
+ * Event from Driver Process to Driver Runtime.
* A request to the Driver Runtime to allocate resources with the given specification
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java
index 169554e..38ded64 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/api/ResourceRequestEventImpl.java
@@ -131,7 +131,7 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
/**
* Add a list of node names.
- * @see {@link ResourceRequestEventImpl.Builder#addNodeName}
+ * @see ResourceRequestEventImpl.Builder#addNodeName
*/
public Builder addNodeNames(final List<String> nodeNames) {
for (final String nodeName : nodeNames) {
@@ -141,8 +141,8 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
}
/**
- * Add an entry to rackNameList.
- * @see ResourceRequestEvent#getRackNameList()
+ * Add a list of rack names.
+ * @see ResourceRequestEventImpl.Builder#addRackName
*/
public Builder addRackName(final String rackName) {
this.rackNameList.add(rackName);
@@ -150,8 +150,8 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
}
/**
- * Add a list of rack names.
- * @see {@link ResourceRequestEventImpl.Builder#addRackName}
+ * Add an entry to rackNameList.
+ * @see ResourceRequestEvent#getRackNameList
*/
public Builder addRackNames(final List<String> rackNames) {
for (final String rackName : rackNames) {
@@ -161,7 +161,7 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
}
/**
- * @see ResourceRequestEvent#getMemorySize()
+ * @see ResourceRequestEvent#getMemorySize
*/
public Builder setMemorySize(final int memorySize) {
this.memorySize = memorySize;
@@ -169,7 +169,7 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
}
/**
- * @see ResourceRequestEvent#getPriority()
+ * @see ResourceRequestEvent#getPriority
*/
public Builder setPriority(final int priority) {
this.priority = priority;
@@ -177,7 +177,7 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
}
/**
- * @see ResourceRequestEvent#getVirtualCores()
+ * @see ResourceRequestEvent#getVirtualCores
*/
public Builder setVirtualCores(final int virtualCores) {
this.virtualCores = virtualCores;
@@ -185,7 +185,7 @@ public final class ResourceRequestEventImpl implements ResourceRequestEvent {
}
/**
- * @see ResourceRequestEvent#getRelaxLocality()
+ * @see ResourceRequestEvent#getRelaxLocality
*/
public Builder setRelaxLocality(final boolean relaxLocality) {
this.relaxLocality = relaxLocality;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java
index a149309..708cbdc 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/EvaluatorManager.java
@@ -68,12 +68,12 @@ import java.util.logging.Logger;
/**
* Manages a single Evaluator instance including all lifecycle instances:
* (AllocatedEvaluator, CompletedEvaluator, FailedEvaluator).
- * <p/>
- * A (periodic) heartbeat channel is established EvaluatorRuntime -> EvaluatorManager.
+ * <p>
+ * A (periodic) heartbeat channel is established from EvaluatorRuntime to EvaluatorManager.
* The EvaluatorRuntime will (periodically) send (status) messages to the EvaluatorManager using this
* heartbeat channel.
- * <p/>
- * A (push-based) EventHandler channel is established EvaluatorManager -> EvaluatorRuntime.
+ * <p>
+ * A (push-based) EventHandler channel is established from EvaluatorManager to EvaluatorRuntime.
* The EvaluatorManager uses this to forward Driver messages, launch Tasks, and initiate
* control information (e.g., shutdown, suspend).
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/Evaluators.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/Evaluators.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/Evaluators.java
index 8acf102..59ee6a8 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/Evaluators.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/Evaluators.java
@@ -96,7 +96,7 @@ public final class Evaluators implements AutoCloseable {
/**
* Create new EvaluatorManager and add it to the collection.
- * <p/>
+ * <p>
* FIXME: This method is a temporary fix for the race condition
* described in issues #828 and #839.
*
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java
index f742181..03932a4 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/NodeDescriptorEvent.java
@@ -24,7 +24,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation;
import org.apache.reef.util.Optional;
/**
- * Event from Driver Runtime -> Driver Process.
+ * Event from Driver Runtime to Driver Process.
* Description of a node in the cluster
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceAllocationEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceAllocationEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceAllocationEvent.java
index 5b0156e..1b50066 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceAllocationEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceAllocationEvent.java
@@ -22,7 +22,7 @@ import org.apache.reef.annotations.audience.DriverSide;
import org.apache.reef.annotations.audience.RuntimeAuthor;
/**
- * Event from Driver Runtime -> Driver Process
+ * Event from Driver Runtime to Driver Process
* A Resource allocated by the Driver Runtime. In response to a ResourceRequestEvent.
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java
index 9e66e1b..089ea7c 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/ResourceStatusEvent.java
@@ -25,7 +25,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation;
import org.apache.reef.util.Optional;
/**
- * Event from Driver Runtime -> Driver Process.
+ * Event from Driver Runtime to Driver Process.
* Status of a resource in the cluster
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java
index da6b984..18bcce0 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/resourcemanager/RuntimeStatusEvent.java
@@ -27,7 +27,7 @@ import org.apache.reef.util.Optional;
import java.util.List;
/**
- * Event from Driver Runtime -> Driver Process.
+ * Event from Driver Runtime to Driver Process.
* A status update from the Driver Runtime to the Driver Process
*/
@RuntimeAuthor
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java
index 805460c..363ae77 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextManager.java
@@ -136,7 +136,7 @@ public final class ContextManager implements AutoCloseable {
/**
* Processes the given ContextControlProto to launch / close / suspend Tasks and Contexts.
- * <p/>
+ * <p>
* This also triggers the HeartBeatManager to send a heartbeat with the result of this operation.
*
* @param controlMessage the message to process
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextRuntime.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextRuntime.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextRuntime.java
index 172cb64..77a0b29 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextRuntime.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/ContextRuntime.java
@@ -133,7 +133,7 @@ public final class ContextRuntime {
/**
* Spawns a new context.
- * <p/>
+ * <p>
* The new context will have a serviceInjector that is created by forking the one in this object with the given
* serviceConfiguration. The contextConfiguration is used to fork the contextInjector from that new serviceInjector.
*
@@ -187,7 +187,7 @@ public final class ContextRuntime {
/**
* Spawns a new context without services of its own.
- * <p/>
+ * <p>
* The new context will have a serviceInjector that is created by forking the one in this object. The
* contextConfiguration is used to fork the contextInjector from that new serviceInjector.
*
@@ -307,7 +307,7 @@ public final class ContextRuntime {
/**
* Deliver the given message to the Task.
- * <p/>
+ * <p>
* Note that due to races, the task might have already ended. In that case, we drop this call and leave a WARNING
* in the log.
*
@@ -325,7 +325,7 @@ public final class ContextRuntime {
/**
* Issue a close call to the Task
- * <p/>
+ * <p>
* Note that due to races, the task might have already ended. In that case, we drop this call and leave a WARNING
* in the log.
*
@@ -343,7 +343,7 @@ public final class ContextRuntime {
/**
* Deliver a message to the Task
- * <p/>
+ * <p>
* Note that due to races, the task might have already ended. In that case, we drop this call and leave a WARNING
* in the log.
*
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/RootContextLauncher.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/RootContextLauncher.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/RootContextLauncher.java
index ced3920..9f18e6c 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/RootContextLauncher.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/context/RootContextLauncher.java
@@ -93,7 +93,7 @@ final class RootContextLauncher {
/**
* Instantiates the root context.
- * <p/>
+ * <p>
* This also launches the initial task if there is any.
*
* @param injector
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/ApplicationIdentifier.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/ApplicationIdentifier.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/ApplicationIdentifier.java
index 27aa53b..7571403 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/ApplicationIdentifier.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/parameters/ApplicationIdentifier.java
@@ -23,7 +23,7 @@ import org.apache.reef.tang.annotations.NamedParameter;
/**
* The RM application/job identifier.
- * <p/>
+ * <p>
* In YARN, this is the applicationID assigned by the resource manager.
*/
@NamedParameter(doc = "The RM application/job identifier.")
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java
index 7c81ed7..46f2281 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultCloseHandler.java
@@ -25,7 +25,7 @@ import org.apache.reef.wake.EventHandler;
import javax.inject.Inject;
/**
- * Default implementation for EventHandler<CloseEvent>.
+ * Default implementation for {@code EventHandler<CloseEvent>}.
*/
@Private
public final class DefaultCloseHandler implements EventHandler<CloseEvent> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java
index 4c7f5fe..6e87aea 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/evaluator/task/defaults/DefaultDriverMessageHandler.java
@@ -25,7 +25,7 @@ import org.apache.reef.wake.EventHandler;
import javax.inject.Inject;
/**
- * A default implementation of EventHandler<DriverMessage>.
+ * A default implementation of {@code EventHandler<DriverMessage>}.
*/
@Private
public final class DefaultDriverMessageHandler implements EventHandler<DriverMessage> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java
index 8f31fa2..be25102 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/files/REEFFileNames.java
@@ -169,7 +169,7 @@ public final class REEFFileNames {
/**
* The prefix used whenever REEF is asked to create a job folder, on (H)DFS or locally.
- * <p/>
+ * <p>
* This prefix is also used with JAR files created to represent a job.
*/
public String getJobFolderPrefix() {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/REEFUncaughtExceptionHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/REEFUncaughtExceptionHandler.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/REEFUncaughtExceptionHandler.java
index 2b19f33..cddb114 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/REEFUncaughtExceptionHandler.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/launch/REEFUncaughtExceptionHandler.java
@@ -28,10 +28,10 @@ import java.util.logging.Logger;
/**
* This is used as the Exception handler for REEF client processes (Driver, Evaluator).
- * <p/>
+ * <p>
* It catches all exceptions and sends them to the controlling process.
* For Evaluators, that is the Driver. For the Driver, that is the Client.
- * <p/>
+ * <p>
* After sending the exception, this shuts down the JVM, as this JVM is then officially dead.
*/
public final class REEFUncaughtExceptionHandler implements Thread.UncaughtExceptionHandler {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/task/HeartBeatTriggerManager.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/task/HeartBeatTriggerManager.java b/lang/java/reef-common/src/main/java/org/apache/reef/task/HeartBeatTriggerManager.java
index 355bc30..cae3786 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/task/HeartBeatTriggerManager.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/task/HeartBeatTriggerManager.java
@@ -28,10 +28,11 @@ import javax.inject.Inject;
/**
* Helper class for immediately sending heartbeat messages.
* This can be used together with TaskMessageSource to push urgent messages to the Driver.
- * <p/>
+ * <p>
* CAUTION: Do not overuse as the Driver can be saturated with heartbeats.
*
- * @see https://issues.apache.org/jira/browse/REEF-33 for the ongoing discussion of alternatives to this design.
+ * @see <a href="https://issues.apache.org/jira/browse/REEF-33">REEF-33</a> for the ongoing discussion of
+ * alternatives to this design.
*/
@TaskSide
@Public
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/task/Task.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/task/Task.java b/lang/java/reef-common/src/main/java/org/apache/reef/task/Task.java
index e41f6a8..d9ef02e 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/task/Task.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/task/Task.java
@@ -23,9 +23,9 @@ import org.apache.reef.annotations.audience.TaskSide;
/**
* The interface for Tasks.
- * <p/>
+ * <p>
* This interface is to be implemented for Tasks.
- * <p/>
+ * <p>
* The main entry point for a Task is the call() method inherited from
* {@link java.util.concurrent.Callable}. The REEF Evaluator will call this method in order to run
* the Task. The byte[] returned by it will be pushed to the Job Driver.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/task/TaskMessageSource.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/task/TaskMessageSource.java b/lang/java/reef-common/src/main/java/org/apache/reef/task/TaskMessageSource.java
index c9fc912..9572079 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/task/TaskMessageSource.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/task/TaskMessageSource.java
@@ -24,7 +24,7 @@ import org.apache.reef.util.Optional;
/**
* Message source for control flow messages from a task to the Driver.
- * <p/>
+ * <p>
* The getMessage() method in an Implementation of this interface will be called by the Evaluator resourcemanager
* whenever it is about to communicate with the Driver anyway.
* Hence, this can be used for occasional status updates etc.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java
index dc80dee..878e165 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/BuilderUtils.java
@@ -24,6 +24,9 @@ package org.apache.reef.util;
public final class BuilderUtils {
/**
* Throws a runtime exception if the parameter is null.
+ * @param <T> a type of parameter
+ * @param parameter
+ * @return the parameter if it is not null
*/
public static <T> T notNull(final T parameter) {
if (parameter == null) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/util/CollectionUtils.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/CollectionUtils.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/CollectionUtils.java
index ca94928..f936390 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/CollectionUtils.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/CollectionUtils.java
@@ -32,6 +32,7 @@ public final class CollectionUtils {
/**
* Checks if the collection is null or empty.
+ * @param <T> a type of element of collection
* @param parameter the collection
* @return true if the collection is null or empty
*/
@@ -41,9 +42,9 @@ public final class CollectionUtils {
/**
* Checks if the collection is not null and not empty.
+ * @param <T> a type of element of collection
* @param parameter the collection
* @return true if the collection is not null nor empty
- *
*/
public static <T> boolean isNotEmpty(final Collection<T> parameter) {
return !isEmpty(parameter);
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/util/EnvironmentUtils.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/EnvironmentUtils.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/EnvironmentUtils.java
index 3fdb7ee..fef20aa 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/EnvironmentUtils.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/EnvironmentUtils.java
@@ -56,6 +56,7 @@ public final class EnvironmentUtils {
* Get a set of all classpath entries EXCEPT of those under excludeEnv directories.
* Every excludeEnv entry is an environment variable name.
*
+ * @param excludeEnv A set of environments to be excluded.
* @return A set of classpath entries as strings.
*/
public static Set<String> getAllClasspathJars(final String... excludeEnv) {
@@ -113,7 +114,7 @@ public final class EnvironmentUtils {
}
/**
- * @param clazz
+ * @param clazz class
* @return the location (JAR or .class file) where the given class is located.
*/
public static String getClassLocation(final Class<?> clazz) {