Added some javadoc CTR
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/309957bc Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/309957bc Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/309957bc Branch: refs/heads/TINKERPOP-1996 Commit: 309957bc210eacc93114a261e3dbf1bb0db40231 Parents: 34a648b Author: Stephen Mallette <sp...@genoprime.com> Authored: Sat Jun 30 06:24:23 2018 -0400 Committer: Stephen Mallette <sp...@genoprime.com> Committed: Sat Jun 30 06:24:23 2018 -0400 ---------------------------------------------------------------------- .../dsl/graph/GraphTraversalSource.java | 84 +++++++++++++++++++- 1 file changed, 83 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/309957bc/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversalSource.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversalSource.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversalSource.java index 1b6a218..baba19c 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversalSource.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversalSource.java @@ -122,11 +122,17 @@ public class GraphTraversalSource implements TraversalSource { //// CONFIGURATIONS + /** + * {@inheritDoc} + */ @Override public GraphTraversalSource withStrategies(final TraversalStrategy... traversalStrategies) { return (GraphTraversalSource) TraversalSource.super.withStrategies(traversalStrategies); } + /** + * {@inheritDoc} + */ @Override @SuppressWarnings({"unchecked"}) public GraphTraversalSource withoutStrategies(final Class<? extends TraversalStrategy>... traversalStrategyClasses) { @@ -139,76 +145,121 @@ public class GraphTraversalSource implements TraversalSource { return (GraphTraversalSource) TraversalSource.super.withBindings(bindings); } + /** + * {@inheritDoc} + */ @Override public GraphTraversalSource withComputer(final Computer computer) { return (GraphTraversalSource) TraversalSource.super.withComputer(computer); } + /** + * {@inheritDoc} + */ @Override public GraphTraversalSource withComputer(final Class<? extends GraphComputer> graphComputerClass) { return (GraphTraversalSource) TraversalSource.super.withComputer(graphComputerClass); } + /** + * {@inheritDoc} + */ @Override public GraphTraversalSource withComputer() { return (GraphTraversalSource) TraversalSource.super.withComputer(); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSideEffect(final String key, final Supplier<A> initialValue, final BinaryOperator<A> reducer) { return (GraphTraversalSource) TraversalSource.super.withSideEffect(key, initialValue, reducer); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSideEffect(final String key, final A initialValue, final BinaryOperator<A> reducer) { return (GraphTraversalSource) TraversalSource.super.withSideEffect(key, initialValue, reducer); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSideEffect(final String key, final A initialValue) { return (GraphTraversalSource) TraversalSource.super.withSideEffect(key, initialValue); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSideEffect(final String key, final Supplier<A> initialValue) { return (GraphTraversalSource) TraversalSource.super.withSideEffect(key, initialValue); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSack(final Supplier<A> initialValue, final UnaryOperator<A> splitOperator, final BinaryOperator<A> mergeOperator) { return (GraphTraversalSource) TraversalSource.super.withSack(initialValue, splitOperator, mergeOperator); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSack(final A initialValue, final UnaryOperator<A> splitOperator, final BinaryOperator<A> mergeOperator) { return (GraphTraversalSource) TraversalSource.super.withSack(initialValue, splitOperator, mergeOperator); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSack(final A initialValue) { return (GraphTraversalSource) TraversalSource.super.withSack(initialValue); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSack(final Supplier<A> initialValue) { return (GraphTraversalSource) TraversalSource.super.withSack(initialValue); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSack(final Supplier<A> initialValue, final UnaryOperator<A> splitOperator) { return (GraphTraversalSource) TraversalSource.super.withSack(initialValue, splitOperator); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSack(final A initialValue, final UnaryOperator<A> splitOperator) { return (GraphTraversalSource) TraversalSource.super.withSack(initialValue, splitOperator); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSack(final Supplier<A> initialValue, final BinaryOperator<A> mergeOperator) { return (GraphTraversalSource) TraversalSource.super.withSack(initialValue, mergeOperator); } + /** + * {@inheritDoc} + */ @Override public <A> GraphTraversalSource withSack(final A initialValue, final BinaryOperator<A> mergeOperator) { return (GraphTraversalSource) TraversalSource.super.withSack(initialValue, mergeOperator); @@ -230,16 +281,25 @@ public class GraphTraversalSource implements TraversalSource { return clone; } + /** + * {@inheritDoc} + */ @Override public GraphTraversalSource withRemote(final Configuration conf) { return (GraphTraversalSource) TraversalSource.super.withRemote(conf); } + /** + * {@inheritDoc} + */ @Override public GraphTraversalSource withRemote(final String configFile) throws Exception { return (GraphTraversalSource) TraversalSource.super.withRemote(configFile); } + /** + * {@inheritDoc} + */ @Override public GraphTraversalSource withRemote(final RemoteConnection connection) { try { @@ -280,6 +340,9 @@ public class GraphTraversalSource implements TraversalSource { } } + /** + * Spawns a {@link GraphTraversal} by adding a vertex with the specified label. + */ public GraphTraversal<Vertex, Vertex> addV(final String label) { final GraphTraversalSource clone = this.clone(); clone.bytecode.addStep(GraphTraversal.Symbols.addV, label); @@ -287,6 +350,9 @@ public class GraphTraversalSource implements TraversalSource { return traversal.addStep(new AddVertexStartStep(traversal, label)); } + /** + * Spawns a {@link GraphTraversal} by adding a vertex with the default label. + */ public GraphTraversal<Vertex, Vertex> addV() { final GraphTraversalSource clone = this.clone(); clone.bytecode.addStep(GraphTraversal.Symbols.addV); @@ -294,6 +360,9 @@ public class GraphTraversalSource implements TraversalSource { return traversal.addStep(new AddVertexStartStep(traversal, null)); } + /** + * Spawns a {@link GraphTraversal} starting it with arbitrary values. + */ public <S> GraphTraversal<S, S> inject(S... starts) { final GraphTraversalSource clone = this.clone(); clone.bytecode.addStep(GraphTraversal.Symbols.inject, starts); @@ -301,6 +370,10 @@ public class GraphTraversalSource implements TraversalSource { return traversal.addStep(new InjectStep<S>(traversal, starts)); } + /** + * Spawns a {@link GraphTraversal} starting with all vertices or some subset of vertices as specified by their + * unique identifier. + */ public GraphTraversal<Vertex, Vertex> V(final Object... vertexIds) { final GraphTraversalSource clone = this.clone(); clone.bytecode.addStep(GraphTraversal.Symbols.V, vertexIds); @@ -308,6 +381,10 @@ public class GraphTraversalSource implements TraversalSource { return traversal.addStep(new GraphStep<>(traversal, Vertex.class, true, vertexIds)); } + /** + * Spawns a {@link GraphTraversal} starting with all edges or some subset of edges as specified by their unique + * identifier. + */ public GraphTraversal<Edge, Edge> E(final Object... edgesIds) { final GraphTraversalSource clone = this.clone(); clone.bytecode.addStep(GraphTraversal.Symbols.E, edgesIds); @@ -315,11 +392,16 @@ public class GraphTraversalSource implements TraversalSource { return traversal.addStep(new GraphStep<>(traversal, Edge.class, true, edgesIds)); } - + /** + * Proxies calls through to the underlying {@link Graph#tx()}. + */ public Transaction tx() { return this.graph.tx(); } + /** + * If there is an underlying {@link RemoteConnection} it will be closed by this method. + */ @Override public void close() throws Exception { if (connection != null) connection.close();