You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by we...@apache.org on 2015/09/16 01:16:40 UTC
incubator-reef git commit: [REEF-522] Add missing Javadoc comments in
Java code: reef-checkpoint
Repository: incubator-reef
Updated Branches:
refs/heads/master bbb78b769 -> 78a02dba6
[REEF-522] Add missing Javadoc comments in Java code: reef-checkpoint
This adds missing Javadoc comments in reef-checkpoint project
and enforces more strict checkstyle rules.
JIRA:
[REEF-522](https://issues.apache.org/jira/browse/REEF-522)
Pull Request:
Closes #492
Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/78a02dba
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/78a02dba
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/78a02dba
Branch: refs/heads/master
Commit: 78a02dba6ea42831a82515555157c9fa4aab9edd
Parents: bbb78b7
Author: Mariia Mykhailova <ma...@apache.org>
Authored: Tue Sep 15 13:56:05 2015 -0700
Committer: Markus Weimer <we...@apache.org>
Committed: Tue Sep 15 16:15:38 2015 -0700
----------------------------------------------------------------------
lang/java/reef-checkpoint/pom.xml | 11 +++++++++++
.../org/apache/reef/io/checkpoint/CheckpointService.java | 6 ++++++
.../org/apache/reef/io/checkpoint/RandomNameCNS.java | 3 +++
.../org/apache/reef/io/checkpoint/fs/package-info.java | 2 +-
.../java/org/apache/reef/io/checkpoint/package-info.java | 2 +-
5 files changed, 22 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/78a02dba/lang/java/reef-checkpoint/pom.xml
----------------------------------------------------------------------
diff --git a/lang/java/reef-checkpoint/pom.xml b/lang/java/reef-checkpoint/pom.xml
index b960e61..e1f5a16 100644
--- a/lang/java/reef-checkpoint/pom.xml
+++ b/lang/java/reef-checkpoint/pom.xml
@@ -48,6 +48,17 @@ under the License.
</excludes>
</resource>
</resources>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <configuration>
+ <configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
</build>
<dependencies>
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/78a02dba/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 df309ce..849e770 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
@@ -92,9 +92,15 @@ public interface CheckpointService {
*/
boolean delete(CheckpointID checkpointId) throws IOException, InterruptedException;
+ /**
+ * A channel to write to a checkpoint.
+ */
interface CheckpointWriteChannel extends WritableByteChannel {
}
+ /**
+ * A channel to read from a checkpoint.
+ */
interface CheckpointReadChannel extends ReadableByteChannel {
}
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/78a02dba/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/RandomNameCNS.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/RandomNameCNS.java b/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/RandomNameCNS.java
index b801ad8..7de31cd 100644
--- a/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/RandomNameCNS.java
+++ b/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/RandomNameCNS.java
@@ -42,6 +42,9 @@ public class RandomNameCNS implements CheckpointNamingService {
return this.prefix + RandomStringUtils.randomAlphanumeric(8);
}
+ /**
+ * The prefix used for the random names returned.
+ */
@NamedParameter(doc = "The prefix used for the random names returned.", default_value = "checkpoint_")
public static class PREFIX implements Name<String> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/78a02dba/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/fs/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/fs/package-info.java b/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/fs/package-info.java
index 41ff34b..c63e054 100644
--- a/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/fs/package-info.java
+++ b/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/fs/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * FileSystem based checkpoints.
*/
package org.apache.reef.io.checkpoint.fs;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/78a02dba/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/package-info.java b/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/package-info.java
index 5b6a72c..4b31977 100644
--- a/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/package-info.java
+++ b/lang/java/reef-checkpoint/src/main/java/org/apache/reef/io/checkpoint/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Checkpoints that provide APIs and implementations to store and retrieve the state of a task.
*/
package org.apache.reef.io.checkpoint;