accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctubb...@apache.org
Subject [4/9] git commit: ACCUMULO-3068 ACCUMULO-2558 Fix incorrect/incomplete javadocs
Date Sat, 23 Aug 2014 00:37:55 GMT
ACCUMULO-3068 ACCUMULO-2558 Fix incorrect/incomplete javadocs


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

Branch: refs/heads/master
Commit: da28b8b15ecd091e51840ed1655afc5a264f2a8e
Parents: ac2e601
Author: Christopher Tubbs <ctubbsii@apache.org>
Authored: Fri Aug 22 19:57:40 2014 -0400
Committer: Christopher Tubbs <ctubbsii@apache.org>
Committed: Fri Aug 22 19:57:40 2014 -0400

----------------------------------------------------------------------
 .../conf/CredentialProviderFactoryShim.java     |  2 -
 .../accumulo/gc/SimpleGarbageCollector.java     | 46 ++++++++++++--------
 2 files changed, 29 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/da28b8b1/core/src/main/java/org/apache/accumulo/core/conf/CredentialProviderFactoryShim.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/accumulo/core/conf/CredentialProviderFactoryShim.java
b/core/src/main/java/org/apache/accumulo/core/conf/CredentialProviderFactoryShim.java
index 91dcc54..aa3d195 100644
--- a/core/src/main/java/org/apache/accumulo/core/conf/CredentialProviderFactoryShim.java
+++ b/core/src/main/java/org/apache/accumulo/core/conf/CredentialProviderFactoryShim.java
@@ -368,7 +368,6 @@ public class CredentialProviderFactoryShim {
    *          CredentialEntry name (alias)
    * @param credential
    *          The credential
-   * @throws IOException
    */
   public static void createEntry(Configuration conf, String name, char[] credential) throws
IOException {
     Preconditions.checkNotNull(conf);
@@ -403,7 +402,6 @@ public class CredentialProviderFactoryShim {
    *          CredentialEntry name (alias)
    * @param credential
    *          The credential to store
-   * @throws IOException
    */
   public static void createEntryInProvider(Object credentialProvider, String name, char[]
credential) throws IOException {
     Preconditions.checkNotNull(credentialProvider);

http://git-wip-us.apache.org/repos/asf/accumulo/blob/da28b8b1/server/gc/src/main/java/org/apache/accumulo/gc/SimpleGarbageCollector.java
----------------------------------------------------------------------
diff --git a/server/gc/src/main/java/org/apache/accumulo/gc/SimpleGarbageCollector.java b/server/gc/src/main/java/org/apache/accumulo/gc/SimpleGarbageCollector.java
index 64db1db..a1c9673 100644
--- a/server/gc/src/main/java/org/apache/accumulo/gc/SimpleGarbageCollector.java
+++ b/server/gc/src/main/java/org/apache/accumulo/gc/SimpleGarbageCollector.java
@@ -119,8 +119,7 @@ public class SimpleGarbageCollector implements Iface {
   }
 
   /**
-   * A fraction representing how much of the JVM's available memory should be
-   * used for gathering candidates.
+   * A fraction representing how much of the JVM's available memory should be used for gathering
candidates.
    */
   static final float CANDIDATE_MEMORY_PERCENTAGE = 0.75f;
 
@@ -155,7 +154,8 @@ public class SimpleGarbageCollector implements Iface {
   /**
    * Creates a new garbage collector.
    *
-   * @param opts options
+   * @param opts
+   *          options
    */
   public SimpleGarbageCollector(Opts opts) {
     this.opts = opts;
@@ -169,6 +169,7 @@ public class SimpleGarbageCollector implements Iface {
   Credentials getCredentials() {
     return credentials;
   }
+
   /**
    * Gets the delay before the first collection.
    *
@@ -177,6 +178,7 @@ public class SimpleGarbageCollector implements Iface {
   long getStartDelay() {
     return config.getTimeInMillis(Property.GC_CYCLE_START);
   }
+
   /**
    * Gets the volume manager used by this GC.
    *
@@ -185,21 +187,23 @@ public class SimpleGarbageCollector implements Iface {
   VolumeManager getVolumeManager() {
     return fs;
   }
+
   /**
-   * Checks if the volume manager should move files to the trash rather than
-   * delete them.
+   * Checks if the volume manager should move files to the trash rather than delete them.
    *
    * @return true if trash is used
    */
   boolean isUsingTrash() {
     return !config.getBoolean(Property.GC_TRASH_IGNORE);
   }
+
   /**
    * Gets the options for this garbage collector.
    */
   Opts getOpts() {
     return opts;
   }
+
   /**
    * Gets the number of threads used for deleting files.
    *
@@ -208,6 +212,7 @@ public class SimpleGarbageCollector implements Iface {
   int getNumDeleteThreads() {
     return config.getCount(Property.GC_DELETE_THREADS);
   }
+
   /**
    * Gets the instance used by this GC.
    *
@@ -220,11 +225,14 @@ public class SimpleGarbageCollector implements Iface {
   /**
    * Initializes this garbage collector.
    *
-   * @param fs volume manager
-   * @param instance instance
-   * @param credentials credentials
-   * @param noTrash true to not move files to trash instead of deleting
-   * @param systemConfig system configuration
+   * @param fs
+   *          volume manager
+   * @param instance
+   *          instance
+   * @param credentials
+   *          credentials
+   * @param config
+   *          system configuration
    */
   public void init(VolumeManager fs, Instance instance, Credentials credentials, AccumuloConfiguration
config) {
     this.fs = fs;
@@ -579,13 +587,13 @@ public class SimpleGarbageCollector implements Iface {
   }
 
   /**
-   * Moves a file to trash. If this garbage collector is not using trash, this
-   * method returns false and leaves the file alone. If the file is missing,
-   * this method returns false as opposed to throwing an exception.
+   * Moves a file to trash. If this garbage collector is not using trash, this method returns
false and leaves the file alone. If the file is missing, this
+   * method returns false as opposed to throwing an exception.
    *
    * @param path
    * @return true if the file was moved to trash
-   * @throws IOException if the volume manager encountered a problem
+   * @throws IOException
+   *           if the volume manager encountered a problem
    */
   boolean moveToTrash(Path path) throws IOException {
     if (!isUsingTrash())
@@ -646,7 +654,8 @@ public class SimpleGarbageCollector implements Iface {
   /**
    * Checks if the system is almost out of memory.
    *
-   * @param runtime Java runtime
+   * @param runtime
+   *          Java runtime
    * @return true if system is almost out of memory
    * @see #CANDIDATE_MEMORY_PERCENTAGE
    */
@@ -665,11 +674,14 @@ public class SimpleGarbageCollector implements Iface {
   /**
    * Checks if the given string is a directory.
    *
-   * @param delete possible directory
+   * @param delete
+   *          possible directory
    * @return true if string is a directory
    */
   static boolean isDir(String delete) {
-    if (delete == null) { return false; }
+    if (delete == null) {
+      return false;
+    }
     int slashCount = 0;
     for (int i = 0; i < delete.length(); i++)
       if (delete.charAt(i) == '/')


Mime
View raw message