You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/04/13 19:22:54 UTC

[33/43] incubator-tinkerpop git commit: Add javadoc.

Add javadoc.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/01f930ba
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/01f930ba
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/01f930ba

Branch: refs/heads/master
Commit: 01f930babf1d44f453e44a6788df822d03b65839
Parents: 59493d6
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Apr 10 13:00:17 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Apr 10 13:00:17 2015 -0400

----------------------------------------------------------------------
 .../org/apache/tinkerpop/gremlin/AbstractGraphProvider.java | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/01f930ba/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/AbstractGraphProvider.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/AbstractGraphProvider.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/AbstractGraphProvider.java
index 8fe041b..e439d29 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/AbstractGraphProvider.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/AbstractGraphProvider.java
@@ -86,7 +86,10 @@ public abstract class AbstractGraphProvider implements GraphProvider {
         }
     }
 
-    // todo: these aren't used - remove???
+    /**
+     * Helper method for those building {@link GraphProvider} implementations that need to clean directories
+     * between test runs.
+     */
     protected static void deleteDirectory(final File directory) {
         if (directory.exists()) {
             for (File file : directory.listFiles()) {
@@ -107,6 +110,10 @@ public abstract class AbstractGraphProvider implements GraphProvider {
         if (directory.exists()) System.err.println("unable to delete directory " + directory.getAbsolutePath());
     }
 
+    /**
+     * Helper method for those build {@link GraphProvider} implementations that need a standard working directory
+     * for tests (e.g. graphs that persist data to disk).
+     */
     protected String getWorkingDirectory() {
         return TestHelper.makeTestDataPath(this.getClass(), "graph-provider-data").getAbsolutePath();
     }