TINKERPOP-789 Improve javadoc around Graph.close() CTR
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/3e348045 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/3e348045 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/3e348045 Branch: refs/heads/TINKERPOP-1688 Commit: 3e348045b00f2c1887e29203e4224d4a708287dd Parents: d11c1f5 Author: Stephen Mallette <[email protected]> Authored: Sat Jun 17 06:47:53 2017 -0400 Committer: Stephen Mallette <[email protected]> Committed: Sat Jun 17 06:47:53 2017 -0400 ---------------------------------------------------------------------- .../org/apache/tinkerpop/gremlin/structure/Graph.java | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/3e348045/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java index 9b1cd53..1f59719 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java @@ -292,12 +292,15 @@ public interface Graph extends AutoCloseable, Host { public Transaction tx(); /** - * Closing a {@code Graph} is equivalent to "shutdown" and implies that no futher operations can be executed on + * Closing a {@code Graph} is equivalent to "shutdown" and implies that no further operations can be executed on * the instance. Users should consult the documentation of the underlying graph database implementation for what - * this "shutdown" will mean as it pertains to open transactions. It will typically be the end user's - * responsibility to synchronize the thread that calls {@code close()} with other threads that are accessing open - * transactions. In other words, be sure that all work performed on the {@code Graph} instance is complete prior - * to calling this method. + * this "shutdown" will mean in general and, if supported, how open transactions are handled. It will typically + * be the end user's responsibility to synchronize the thread that calls {@code close()} with other threads that + * are accessing open transactions. In other words, be sure that all work performed on the {@code Graph} instance + * is complete prior to calling this method. + * <p/> + * TinkerPop does not enforce any particular semantics with respect to "shutdown". It is up to the graph provider + * to decide what this method will do. */ @Override void close() throws Exception;
