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 2016/01/19 20:02:07 UTC
[04/11] incubator-tinkerpop git commit: Cleaned up all the
gremlin-core javadoc errors.
Cleaned up all the gremlin-core javadoc errors.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/3ade0b0f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/3ade0b0f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/3ade0b0f
Branch: refs/heads/TINKERPOP-998
Commit: 3ade0b0f17f8a404285e0107c7c975aac24c97f5
Parents: 6c85a45
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Thu Jan 14 11:41:06 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Thu Jan 14 11:41:06 2016 -0500
----------------------------------------------------------------------
.../traversal/dsl/graph/GraphTraversal.java | 21 ++++++++++----------
.../traverser/TraverserRequirement.java | 3 ++-
.../traversal/util/DependantMutableMetrics.java | 5 ++---
.../gremlin/structure/util/ElementHelper.java | 5 +++--
4 files changed, 18 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/3ade0b0f/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
index 488298f..a70a1c2 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
@@ -137,6 +137,7 @@ import org.apache.tinkerpop.gremlin.structure.Column;
import org.apache.tinkerpop.gremlin.structure.Direction;
import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Element;
+import org.apache.tinkerpop.gremlin.structure.Graph;
import org.apache.tinkerpop.gremlin.structure.Property;
import org.apache.tinkerpop.gremlin.structure.PropertyType;
import org.apache.tinkerpop.gremlin.structure.T;
@@ -188,7 +189,6 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
* Map a traverser referencing an object of type <code>E</code> to an object of type <code>E2</code>.
*
* @param function the lambda expression that does the functional mapping
- * @param <E2>the mapping end type
* @return the traversal with an appended {@link LambdaMapStep}.
*/
public default <E2> GraphTraversal<S, E2> map(final Function<Traverser<E>, E2> function) {
@@ -1023,17 +1023,17 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
}
/**
- * Sets a {@link Property} value and related meta properties if supplied, if supported by the {@link org.apache.tinkerpop.gremlin.structure.Graph}
+ * Sets a {@link Property} value and related meta properties if supplied, if supported by the {@link Graph}
* and if the {@link Element} is a {@link VertexProperty}. This method is the long-hand version of
- * {@link #property(Object, Object, Object...)} with the difference that the {@link VertexProperty.Cardinality}
- * can be supplied.
+ * {@link #property(Object, Object, Object...)} with the difference that the
+ * {@link org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality} can be supplied.
* <p/>
* Generally speaking, this method will append an {@link AddPropertyStep} to the {@link Traversal} but when
* possible, this method will attempt to fold key/value pairs into an {@link AddVertexStep}, {@link AddEdgeStep} or
* {@link AddVertexStartStep}. This potential optimization can only happen if cardinality is not supplied
* and when meta-properties are not included.
*
- * @param cardinality the specified cardinality of the property where {@code null} will allow the {@link org.apache.tinkerpop.gremlin.structure.Graph}
+ * @param cardinality the specified cardinality of the property where {@code null} will allow the {@link Graph}
* to use its default settings
* @param key the key for the property
* @param value the value for the property
@@ -1054,12 +1054,13 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
/**
* Sets the key and value of a {@link Property}. If the {@link Element} is a {@link VertexProperty} and the
- * {@link org.apache.tinkerpop.gremlin.structure.Graph} supports it, meta properties can be set. Use of this method assumes that the
- * {@link VertexProperty.Cardinality} is defaulted to {@code null} which means that the default cardinality
- * for the {@link org.apache.tinkerpop.gremlin.structure.Graph} will be used.
+ * {@link Graph} supports it, meta properties can be set. Use of this method assumes that the
+ * {@link org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality} is defaulted to {@code null} which
+ * means that the default cardinality for the {@link Graph} will be used.
* <p/>
- * This method is effectively calls {@link #property(VertexProperty.Cardinality, Object, Object, Object...)} as
- * {@code property(null, key, value, keyValues}.
+ * This method is effectively calls
+ * {@link #property(org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality, Object, Object, Object...)}
+ * as {@code property(null, key, value, keyValues}.
*
* @param key the key for the property
* @param value the value for the property
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/3ade0b0f/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/traverser/TraverserRequirement.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/traverser/TraverserRequirement.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/traverser/TraverserRequirement.java
index ac2c509..88d1d21 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/traverser/TraverserRequirement.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/traverser/TraverserRequirement.java
@@ -26,7 +26,8 @@ import org.apache.tinkerpop.gremlin.process.traversal.Traverser;
* A {@link TraverserRequirement} is a list of requirements that a {@link Traversal} requires of a {@link Traverser}.
* The less requirements, the simpler the traverser can be (both in terms of space and time constraints).
* Every {@link Step} provides its specific requirements via {@link Step#getRequirements()}.
- * Moreover, every {@link Traversal.Admin} can be provided requirements via {@link Traversal.Admin#addTraverserRequirement(TraverserRequirement)}.
+ * Moreover, every {@link org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin} can be provided requirements via
+ * {@link org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin#addTraverserRequirement(TraverserRequirement)}.
*
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/3ade0b0f/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/DependantMutableMetrics.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/DependantMutableMetrics.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/DependantMutableMetrics.java
index 0ce939a..bb7d50c 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/DependantMutableMetrics.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/util/DependantMutableMetrics.java
@@ -41,9 +41,8 @@ public class DependantMutableMetrics extends MutableMetrics {
}
/**
- * Returns the actual duration taken by this Metrics by subtracting the duration taken by the upstream Step, if one exists.
- * @param unit
- * @return
+ * Returns the actual duration taken by this Metrics by subtracting the duration taken by the upstream Step, if
+ * one exists.
*/
@Override
public long getDuration(final TimeUnit unit) {
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/3ade0b0f/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/ElementHelper.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/ElementHelper.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/ElementHelper.java
index 7a7cf03..d42bdee 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/ElementHelper.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/ElementHelper.java
@@ -52,7 +52,7 @@ public final class ElementHelper {
}
/**
- * Determine whether the Element label can be legally set. This is typically used as a pre-condition check.
+ * Determine whether the {@link Element} label can be legally set. This is typically used as a pre-condition check.
*
* @param label the element label
* @throws IllegalArgumentException whether the label is legal and if not, a clear reason exception is provided
@@ -70,7 +70,8 @@ public final class ElementHelper {
* Determine whether an array of ids are either all elements or ids of elements. This is typically used as a pre-condition check.
*
* @param clazz the class of the element for which the ids will bind
- * @param ids the ids that must be either elements or id objects, else {@link Graph.Exceptions#idArgsMustBeEitherIdOrElement()} is thrown.
+ * @param ids the ids that must be either elements or id objects, else
+ * {@link org.apache.tinkerpop.gremlin.structure.Graph.Exceptions#idArgsMustBeEitherIdOrElement()} is thrown.
*/
public static void validateMixedElementIds(final Class<? extends Element> clazz, final Object... ids) throws IllegalArgumentException {
if (ids.length > 1) {