Mailing-List: contact commits-help@tinkerpop.incubator.apache.org;
 run by ezmlm
Precedence: bulk
Reply-To: dev@tinkerpop.incubator.apache.org
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: spmallette@apache.org
To: commits@tinkerpop.incubator.apache.org
Date: Fri, 11 Mar 2016 14:14:24 -0000
Message-Id: <7a9100634c8b480d8aab59258263acbb@git.apache.org>
In-Reply-To: <96e60db160aa43ae8152772ae40c5368@git.apache.org>
References: <96e60db160aa43ae8152772ae40c5368@git.apache.org>
Subject: [2/5] incubator-tinkerpop git commit: Added some javadoc to
 ServerGraph.

Added some javadoc to ServerGraph.


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

Branch: refs/heads/TINKERPOP-575
Commit: d1139c4cf2a6d03eb7d7968ef9463e2c0f6886a5
Parents: c82fbd0
Author: Stephen Mallette <spmva@genoprime.com>
Authored: Thu Mar 10 17:23:32 2016 -0500
Committer: Stephen Mallette <spmva@genoprime.com>
Committed: Thu Mar 10 17:23:32 2016 -0500

----------------------------------------------------------------------
 .../tinkerpop/gremlin/process/server/ServerGraph.java  | 13 +++++++++++++
 1 file changed, 13 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d1139c4c/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/server/ServerGraph.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/server/ServerGraph.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/server/ServerGraph.java
index c84a108..dfe8ae9 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/server/ServerGraph.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/server/ServerGraph.java
@@ -32,6 +32,11 @@ import java.util.Collections;
 import java.util.Iterator;
 
 /**
+ * A {@code ServerGraph} represents a proxy by which traversals spawned from this graph are expected over a
+ * {@link ServerConnection}. This is not a full {@link Graph} implementation in the sense that the most of the methods
+ * will throw an {@link UnsupportedOperationException}.  This implementation can only be used for spawning remote
+ * traversal instances.
+ *
  * @author Stephen Mallette (http://stephen.genoprime.com)
  */
 public class ServerGraph implements Graph {
@@ -49,6 +54,14 @@ public class ServerGraph implements Graph {
         return null;
     }
 
+    /**
+     * Creates a new {@link ServerGraph} instance. {@link ServerGraph} will attempt to call the
+     * {@link ServerConnection#close()} method when the {@link #close()} method is called on this class.
+     *
+     * @param connection the {@link ServerConnection} instance to use
+     * @param graphClass the {@link Graph} class expected to be executed on the other side of the
+     * {@link ServerConnection}
+     */
     public static ServerGraph open(final ServerConnection connection, final Class<? extends Graph> graphClass) {
         return new ServerGraph(connection, graphClass);
     }