Repository: tinkerpop Updated Branches: refs/heads/tp31 f8f3349fe -> 0fefa12cd
Fixed up some javadoc to clarify expectations on Graph.edges/vertices() TINKERPOP-1418 CTR Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/0fefa12c Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/0fefa12c Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/0fefa12c Branch: refs/heads/tp31 Commit: 0fefa12cd5d5ff80da254242db7c5ef3ae2d69cf Parents: f8f3349 Author: Stephen Mallette <sp...@genoprime.com> Authored: Fri Sep 2 11:36:12 2016 -0400 Committer: Stephen Mallette <sp...@genoprime.com> Committed: Fri Sep 2 11:36:12 2016 -0400 ---------------------------------------------------------------------- CHANGELOG.asciidoc | 1 + .../tinkerpop/gremlin/structure/Graph.java | 26 +++++++++++++------- 2 files changed, 18 insertions(+), 9 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/0fefa12c/CHANGELOG.asciidoc ---------------------------------------------------------------------- diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc index 5c2f0ab..9867060 100644 --- a/CHANGELOG.asciidoc +++ b/CHANGELOG.asciidoc @@ -51,6 +51,7 @@ Improvements * TINKERPOP-1376 Rename TinkerPop artifacts * TINKERPOP-1413 PropertiesTest#g_V_hasXageX_propertiesXnameX assumes that ids are longs * TINKERPOP-1416 Write Gremlin Server log files somewhere during doc generation +* TINKERPOP-1418 CoreTraversalTests depend on missing functionality [[release-3-1-3]] TinkerPop 3.1.3 (Release Date: July 18, 2016) http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/0fefa12c/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 bd9870d..83e68e1 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 @@ -171,14 +171,15 @@ public interface Graph extends AutoCloseable, Host { } /** - * Get the {@link Vertex} objects in this graph with the provided vertex ids. If no ids are provided, get all - * vertices. Note that a vertex identifier does not need to correspond to the actual id used in the graph. It - * needs to be a bit more flexible than that in that given the {@link Graph.Features} around id support, multiple - * arguments might be applicable here. + * Get the {@link Vertex} objects in this graph with the provided vertex ids or {@link Vertex} objects themselves. + * If no ids are provided, get all vertices. Note that a vertex identifier does not need to correspond to the + * actual id used in the graph. It needs to be a bit more flexible than that in that given the + * {@link Graph.Features} around id support, multiple arguments might be applicable here. * <p/> * If the graph return {@code true} for {@link Features.VertexFeatures#supportsNumericIds()} then it should support * filters as with: * <ul> + * <li>g.vertices(v)</li> * <li>g.vertices(v.id())</li> * <li>g.vertices(1)</li> * <li>g.vertices(1L)</li> @@ -190,6 +191,7 @@ public interface Graph extends AutoCloseable, Host { * If the graph return {@code true} for {@link Features.VertexFeatures#supportsCustomIds()} ()} then it should support * filters as with: * <ul> + * <li>g.vertices(v)</li> * <li>g.vertices(v.id())</li> * <li>g.vertices(v.id().toString())</li> * </ul> @@ -197,6 +199,7 @@ public interface Graph extends AutoCloseable, Host { * If the graph return {@code true} for {@link Features.VertexFeatures#supportsAnyIds()} ()} then it should support * filters as with: * <ul> + * <li>g.vertices(v)</li> * <li>g.vertices(v.id())</li> * </ul> * <p/> Â @@ -211,6 +214,7 @@ public interface Graph extends AutoCloseable, Host { * If the graph return {@code true} for {@link Features.EdgeFeatures#supportsStringIds()} ()} then it should support * filters as with: * <ul> + * <li>g.vertices(v)</li> * <li>g.vertices(v.id().toString())</li> * <li>g.vertices("id")</li> * </ul> @@ -221,14 +225,15 @@ public interface Graph extends AutoCloseable, Host { public Iterator<Vertex> vertices(final Object... vertexIds); /** - * Get the {@link Edge} objects in this graph with the provided edge ids. If no ids are provided, get all edges. - * Note that an edge identifier does not need to correspond to the actual id used in the graph. It - * needs to be a bit more flexible than that in that given the {@link Graph.Features} around id support, multiple - * arguments might be applicable here. + * Get the {@link Edge} objects in this graph with the provided edge ids or {@link Edge} objects. If no ids are + * provided, get all edges. Note that an edge identifier does not need to correspond to the actual id used in the + * graph. It needs to be a bit more flexible than that in that given the {@link Graph.Features} around id support, + * multiple arguments might be applicable here. * <p/> * If the graph return {@code true} for {@link Features.EdgeFeatures#supportsNumericIds()} then it should support * filters as with: * <ul> + * <li>g.edges(e)</li> * <li>g.edges(e.id())</li> * <li>g.edges(1)</li> * <li>g.edges(1L)</li> @@ -239,7 +244,8 @@ public interface Graph extends AutoCloseable, Host { * <p/> * If the graph return {@code true} for {@link Features.EdgeFeatures#supportsCustomIds()} ()} then it should support * filters as with: - * <ul>\ + * <ul> + * <li>g.edges(e)</li> * <li>g.edges(e.id())</li> * <li>g.edges(e.id().toString())</li> * </ul> @@ -247,12 +253,14 @@ public interface Graph extends AutoCloseable, Host { * If the graph return {@code true} for {@link Features.EdgeFeatures#supportsAnyIds()} ()} then it should support * filters as with: * <ul> + * <li>g.edges(e)</li> * <li>g.edges(e.id())</li> * </ul> * <p/> * If the graph return {@code true} for {@link Features.EdgeFeatures#supportsStringIds()} ()} then it should support * filters as with: * <ul> + * <li>g.edges(e)</li> * <li>g.edges(e.id().toString())</li> * <li>g.edges("id")</li> * </ul>
