accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From els...@apache.org
Subject [09/26] git commit: ACCUMULO-2061 Javadoc
Date Fri, 14 Mar 2014 21:11:35 GMT
ACCUMULO-2061 Javadoc


Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/e3adf78a
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/e3adf78a
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/e3adf78a

Branch: refs/heads/ACCUMULO-2061
Commit: e3adf78a722c131bba2de6d865664415f4601f4c
Parents: 96182f9
Author: Josh Elser <elserj@apache.org>
Authored: Wed Mar 12 16:11:22 2014 -0400
Committer: Josh Elser <elserj@apache.org>
Committed: Wed Mar 12 16:16:36 2014 -0400

----------------------------------------------------------------------
 .../java/org/apache/accumulo/core/volume/Volume.java     | 11 ++++-------
 .../apache/accumulo/core/volume/VolumeConfiguration.java |  3 +++
 .../java/org/apache/accumulo/core/volume/VolumeImpl.java |  3 ++-
 3 files changed, 9 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/e3adf78a/core/src/main/java/org/apache/accumulo/core/volume/Volume.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/accumulo/core/volume/Volume.java b/core/src/main/java/org/apache/accumulo/core/volume/Volume.java
index 487b699..17b2bf3 100644
--- a/core/src/main/java/org/apache/accumulo/core/volume/Volume.java
+++ b/core/src/main/java/org/apache/accumulo/core/volume/Volume.java
@@ -27,33 +27,30 @@ public interface Volume {
 
   /**
    * A {@link FileSystem} that Accumulo will use
-   * @return
    */
   public FileSystem getFileSystem();
 
   /**
    * The base path which Accumulo will use within the given {@link FileSystem}
-   * @return
    */
   public String getBasePath();
 
   /**
    * Convert the given Path into a Path that is relative to the base path for this Volume
-   * @param p
-   * @return
+   * @param p The suffix to use
+   * @return A Path for this Volume with the provided suffix
    */
   public Path prefixChild(Path p);
 
   /**
    * Convert the given child path into a Path that is relative to the base path for this
Volume
-   * @param p
-   * @return
+   * @param p The suffix to use
+   * @return A Path for this Volume with the provided suffix
    */
   public Path prefixChild(String p);
 
   /**
    * Determine if the Path is valid on this Volume (contained by the basePath)
-   * @param p
    * @return True if path is contained within the basePath, false otherwise
    */
   public boolean isValidPath(Path p);

http://git-wip-us.apache.org/repos/asf/accumulo/blob/e3adf78a/core/src/main/java/org/apache/accumulo/core/volume/VolumeConfiguration.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/accumulo/core/volume/VolumeConfiguration.java b/core/src/main/java/org/apache/accumulo/core/volume/VolumeConfiguration.java
index 33d3c35..5db5bb2 100644
--- a/core/src/main/java/org/apache/accumulo/core/volume/VolumeConfiguration.java
+++ b/core/src/main/java/org/apache/accumulo/core/volume/VolumeConfiguration.java
@@ -59,6 +59,9 @@ public class VolumeConfiguration {
       }
   }
 
+  /**
+   * @see org.apache.accumulo.core.volume.VolumeConfiguration#getVolumeUris(AccumuloConfiguration)
+   */
   @Deprecated
   public static String getConfiguredBaseDir(AccumuloConfiguration conf) {
     String singleNamespace = conf.get(Property.INSTANCE_DFS_DIR);

http://git-wip-us.apache.org/repos/asf/accumulo/blob/e3adf78a/core/src/main/java/org/apache/accumulo/core/volume/VolumeImpl.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/accumulo/core/volume/VolumeImpl.java b/core/src/main/java/org/apache/accumulo/core/volume/VolumeImpl.java
index babdcfc..55ccfbc 100644
--- a/core/src/main/java/org/apache/accumulo/core/volume/VolumeImpl.java
+++ b/core/src/main/java/org/apache/accumulo/core/volume/VolumeImpl.java
@@ -25,7 +25,8 @@ import org.apache.hadoop.fs.FileSystem;
 import org.apache.hadoop.fs.Path;
 
 /**
- * 
+ * Basic Volume implementation that contains a FileSystem and a base path 
+ * that should be used within that filesystem.
  */
 public class VolumeImpl implements Volume {
   protected final FileSystem fs;


Mime
View raw message