You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/04/17 13:29:59 UTC
[1/2] incubator-tinkerpop git commit: Clean up javadoc warnings in
gremlin-core.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/master 7bd47a85e -> cd6d0a854
Clean up javadoc warnings in gremlin-core.
Left warnings on DefaultIo since that will likely be removed when refactor-io branch is merged back to master.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/ddc29f11
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/ddc29f11
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/ddc29f11
Branch: refs/heads/master
Commit: ddc29f11430830779cbba7c62d2ef8453a17bd5d
Parents: 7bd47a8
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Apr 17 06:41:32 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Apr 17 06:41:32 2015 -0400
----------------------------------------------------------------------
.../gremlin/process/traversal/Path.java | 9 +++------
.../process/traversal/TraversalStrategies.java | 4 ----
.../gremlin/process/traversal/Traverser.java | 12 ++++++-----
.../gremlin/process/traversal/util/Metrics.java | 10 ----------
.../structure/util/batch/BatchGraph.java | 21 ++++++++------------
5 files changed, 18 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/ddc29f11/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java
index 3d54cd2..b83bd23 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java
@@ -18,6 +18,7 @@
*/
package org.apache.tinkerpop.gremlin.process.traversal;
+import org.apache.tinkerpop.gremlin.structure.Graph;
import org.javatuples.Pair;
import java.util.ArrayList;
@@ -29,10 +30,9 @@ import java.util.stream.IntStream;
import java.util.stream.Stream;
/**
- * A Path denotes a particular walk through a {@link org.apache.tinkerpop.gremlin.structure.Graph} as defined by a {@link Traverser}.
+ * A Path denotes a particular walk through a {@link Graph} as defined by a {@link Traverser}.
* In abstraction, any Path implementation maintains two lists: a list of sets of labels and a list of objects.
- * The list of labels are the labels of the steps traversed.
- * The list of objects are the objects traversed.
+ * The list of labels are the labels of the steps traversed. The list of objects are the objects traversed.
*
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
@@ -130,9 +130,6 @@ public interface Path extends Cloneable {
*/
public List<Set<String>> labels();
- /**
- * {@inheritDoc}
- */
@SuppressWarnings("CloneDoesntDeclareCloneNotSupportedException")
public Path clone();
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/ddc29f11/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/TraversalStrategies.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/TraversalStrategies.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/TraversalStrategies.java
index 92bc7b5..077cc9c 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/TraversalStrategies.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/TraversalStrategies.java
@@ -61,7 +61,6 @@ public interface TraversalStrategies extends Serializable, Cloneable {
* This method must ensure that the strategies are sorted prior to application.
*
* @param traversal the traversal to apply the strategies to
- * @param engine the engine that the traversal is going to be executed on
*/
public void applyStrategies(final Traversal.Admin<?, ?> traversal);
@@ -84,9 +83,6 @@ public interface TraversalStrategies extends Serializable, Cloneable {
@SuppressWarnings("unchecked")
public TraversalStrategies removeStrategies(final Class<? extends TraversalStrategy>... strategyClasses);
- /**
- * {@inheritDoc}
- */
@SuppressWarnings("CloneDoesntDeclareCloneNotSupportedException")
public TraversalStrategies clone();
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/ddc29f11/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Traverser.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Traverser.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Traverser.java
index 97eef72..d177842 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Traverser.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Traverser.java
@@ -25,9 +25,10 @@ import org.apache.tinkerpop.gremlin.structure.util.Attachable;
import java.io.Serializable;
/**
- * A {@link Traverser} represents the current state of an object flowing through a {@link Traversal}.
- * A traverser maintains a reference to the current object, a traverser-local "sack", a traversal-global sideEffect, a bulk count, and a path history.
- * <p/>
+ * A {@code Traverser} represents the current state of an object flowing through a {@link Traversal}.
+ * A traverser maintains a reference to the current object, a traverser-local "sack", a traversal-global sideEffect,
+ * a bulk count, and a path history.
+ * <br/>
* Different types of traverser can exist depending on the semantics of the traversal and the desire for
* space/time optimizations of the developer.
*
@@ -149,7 +150,7 @@ public interface Traverser<T> extends Serializable, Comparable<Traverser<T>>, Cl
public static final String HALT = "halt";
/**
- * When two traversers are {@link Traverser#equals} to each other, then they can be merged.
+ * When two traversers are have equality with each other, then they can be merged.
* This method is used to merge the traversers into a single traverser.
* This is used for optimization where instead of enumerating all traversers, they can be counted.
*
@@ -219,7 +220,8 @@ public interface Traverser<T> extends Serializable, Comparable<Traverser<T>>, Cl
/**
* If the traverser has "no future" then it is done with its lifecycle.
- * This does not mean that the traverser is "dead," only that it has successfully passed through a {@link Traversal}.
+ * This does not mean that the traverser is "dead," only that it has successfully passed through a
+ * {@link Traversal}.
*
* @return Whether the traverser is done executing or not
*/
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/ddc29f11/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/Metrics.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/Metrics.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/Metrics.java
index 6f2c963..4492ee7 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/Metrics.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/Metrics.java
@@ -31,14 +31,8 @@ import java.util.concurrent.TimeUnit;
*/
public interface Metrics {
-
-
-
/**
* Get the duration of execution time taken.
- *
- * @param units
- * @return
*/
public long getDuration(TimeUnit units);
@@ -46,7 +40,6 @@ public interface Metrics {
* Get the count for the corresponding countKey.
*
* @param countKey key for counter to get.
- * @return
*/
public long getCount(String countKey);
@@ -71,7 +64,6 @@ public interface Metrics {
*/
public String getId();
-
/**
* Get the nested Metrics objects. Metrics will be ordered in the order they were inserted.
*
@@ -82,7 +74,6 @@ public interface Metrics {
/**
* Get a nested Metrics object by Id.
*
- * @param metricsId
* @return a nested Metrics object.
*/
Metrics getNested(String metricsId);
@@ -98,7 +89,6 @@ public interface Metrics {
* Obtain the annotation with the specified key. Values may be of type String or Number.
*
* @param key key of the annotation to obtain.
- * @return
*/
public Object getAnnotation(String key);
}
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/ddc29f11/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/batch/BatchGraph.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/batch/BatchGraph.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/batch/BatchGraph.java
index e156815..a2a26f9 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/batch/BatchGraph.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/batch/BatchGraph.java
@@ -23,6 +23,7 @@ import org.apache.commons.configuration.Configuration;
import org.apache.tinkerpop.gremlin.process.computer.GraphComputer;
import org.apache.tinkerpop.gremlin.process.traversal.T;
import org.apache.tinkerpop.gremlin.process.traversal.Traversal;
+import org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.ElementIdStrategy;
import org.apache.tinkerpop.gremlin.structure.Direction;
import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Element;
@@ -45,9 +46,9 @@ import java.util.function.Consumer;
import java.util.function.Function;
/**
- * {@code BatchGraph} is a wrapper that enables batch loading of a large number of edges and vertices by chunking the entire
- * load into smaller batches and maintaining a sideEffects-efficient vertex cache so that the entire transactional state can
- * be flushed after each chunk is loaded.
+ * {@code BatchGraph} is a wrapper that enables batch loading of a large number of edges and vertices by chunking the
+ * entire load into smaller batches and maintaining a sideEffects-efficient vertex cache so that the entire
+ * transactional state can be flushed after each chunk is loaded.
* <br />
* {@code BatchGraph} is ONLY meant for loading data and does not support any retrieval or removal operations.
* That is, BatchGraph only supports the following methods:
@@ -55,20 +56,14 @@ import java.util.function.Function;
* - {@link Vertex#addEdge(String, org.apache.tinkerpop.gremlin.structure.Vertex, Object...)} for adding edges
* - Property getter, setter and removal methods for vertices and edges.
* <br />
- * An important limitation of BatchGraph is that edge properties can only be set immediately after the edge has been added.
- * If other vertices or edges have been created in the meantime, setting, getting or removing properties will throw
- * exceptions. This is done to avoid caching of edges which would require a great amount of sideEffects.
+ * An important limitation of BatchGraph is that edge properties can only be set immediately after the edge has been
+ * added. If other vertices or edges have been created in the meantime, setting, getting or removing properties will
+ * throw exceptions. This is done to avoid caching of edges which would require a great amount of sideEffects.
* <br />
* {@code BatchGraph} can also automatically set the provided element ids as properties on the respective element. Use
* {@link Builder#vertexIdKey(String)} and {@link Builder#edgeIdKey(String)} to set the keys
* for the vertex and edge properties respectively. This allows to make the loaded baseGraph compatible for later
- * operation with {@link org.apache.tinkerpop.gremlin.structure.strategy.IdStrategy}.
- * <br/>
- * Note that {@code BatchGraph} itself is not a {@link org.apache.tinkerpop.gremlin.structure.strategy.GraphStrategy} because
- * it requires that the {@link Vertex} implementation not hold on to the underlying {@link Vertex} reference and
- * {@link org.apache.tinkerpop.gremlin.structure.strategy.StrategyVertex} does that by it's very nature. While it might
- * be possible to work around this issue, it is likely better for performance to simply leave this as a "half-wrapper"
- * implementation, instead of forcing it into a {@link org.apache.tinkerpop.gremlin.structure.strategy.GraphStrategy}.
+ * operation with {@link ElementIdStrategy}.
*
* @author Matthias Broecheler (http://www.matthiasb.com)
* @author Stephen Mallette (http://stephen.genoprime.com)
[2/2] incubator-tinkerpop git commit: Fix javadoc warnings in
gremlin-driver.
Posted by sp...@apache.org.
Fix javadoc warnings in gremlin-driver.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/cd6d0a85
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/cd6d0a85
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/cd6d0a85
Branch: refs/heads/master
Commit: cd6d0a854f26ea8ecb7d2c98b9f25d37dff0975e
Parents: ddc29f1
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Apr 17 07:07:47 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Apr 17 07:07:47 2015 -0400
----------------------------------------------------------------------
.../tinkerpop/gremlin/driver/message/ResponseStatusCode.java | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cd6d0a85/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/message/ResponseStatusCode.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/message/ResponseStatusCode.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/message/ResponseStatusCode.java
index 67594e7..c25d784 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/message/ResponseStatusCode.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/message/ResponseStatusCode.java
@@ -18,6 +18,8 @@
*/
package org.apache.tinkerpop.gremlin.driver.message;
+import org.apache.tinkerpop.gremlin.process.traversal.Traversal;
+
import java.util.HashMap;
import java.util.Map;
import java.util.stream.Stream;
@@ -59,8 +61,8 @@ public enum ResponseStatusCode {
SERVER_ERROR(500),
/**
- * The remote {@link org.apache.tinkerpop.gremlin.process.traversal.Traversal} submitted for processing evaluated in on the
- * server with errors and could not be processed.
+ * The remote {@link Traversal} submitted for processing evaluated in on the server with errors and could not be
+ * processed.
*/
SERVER_ERROR_TRAVERSAL_EVALUATION(596),