TINKERPOP-789 Add javadoc for TinkerGraph's approach to close

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

Branch: refs/heads/TINKERPOP-1688
Commit: d11c1f51c0792ec73ea1a6e09f7ac783e311ca18
Parents: 1d824b5
Author: Stephen Mallette <[email protected]>
Authored: Sat Jun 17 06:44:36 2017 -0400
Committer: Stephen Mallette <[email protected]>
Committed: Sat Jun 17 06:44:36 2017 -0400

----------------------------------------------------------------------
 .../tinkerpop/gremlin/tinkergraph/structure/TinkerGraph.java    | 5 +++++
 1 file changed, 5 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/d11c1f51/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/structure/TinkerGraph.java
----------------------------------------------------------------------
diff --git 
a/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/structure/TinkerGraph.java
 
b/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/structure/TinkerGraph.java
index fa8c62b..5563665 100644
--- 
a/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/structure/TinkerGraph.java
+++ 
b/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/structure/TinkerGraph.java
@@ -251,6 +251,11 @@ public final class TinkerGraph implements Graph {
         this.graphComputerView = null;
     }
 
+    /**
+     * This method only has an effect if the {@link 
#GREMLIN_TINKERGRAPH_GRAPH_LOCATION} is set, in which case the
+     * data in the graph is persisted to that location. This method may be 
called multiple times and does not release
+     * resources.
+     */
     @Override
     public void close() {
         if (graphLocation != null) saveGraph();

Reply via email to