http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/c12e6ae5/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 a8624e6..8070538 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 @@ -192,6 +192,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param function the lambda expression that does the functional mapping * @return the traversal with an appended {@link LambdaMapStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default <E2> GraphTraversal<S, E2> map(final Function<Traverser<E>, E2> function) { @@ -204,6 +205,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param mapTraversal the traversal expression that does the functional mapping * @return the traversal with an appended {@link LambdaMapStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default <E2> GraphTraversal<S, E2> map(final Traversal<?, E2> mapTraversal) { @@ -218,6 +220,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param function the lambda expression that does the functional mapping * @param <E2> the type of the returned iterator objects * @return the traversal with an appended {@link LambdaFlatMapStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default <E2> GraphTraversal<S, E2> flatMap(final Function<Traverser<E>, Iterator<E2>> function) { @@ -232,6 +235,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param flatMapTraversal the traversal generating objects of type <code>E2</code> * @param <E2> the end type of the internal traversal * @return the traversal with an appended {@link TraversalFlatMapStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default <E2> GraphTraversal<S, E2> flatMap(final Traversal<?, E2> flatMapTraversal) { @@ -243,6 +247,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Element} to its {@link Element#id}. * * @return the traversal with an appended {@link IdStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#id-step"; target="_blank">Reference Documentation - Id Step</a> */ public default GraphTraversal<S, Object> id() { @@ -254,6 +259,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Element} to its {@link Element#label}. * * @return the traversal with an appended {@link LabelStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#label-step"; target="_blank">Reference Documentation - Label Step</a> */ public default GraphTraversal<S, String> label() { @@ -265,6 +271,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the <code>E</code> object to itself. In other words, a "no op." * * @return the traversal with an appended {@link IdentityStep}. + * @since 3.0.0-incubating */ public default GraphTraversal<S, E> identity() { this.asAdmin().getBytecode().addStep(Symbols.identity); @@ -275,6 +282,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map any object to a fixed <code>E</code> value. * * @return the traversal with an appended {@link ConstantStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#constant-step"; target="_blank">Reference Documentation - Constant Step</a> */ public default <E2> GraphTraversal<S, E2> constant(final E2 e) { @@ -287,6 +295,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param vertexIdsOrElements vertices to inject into the traversal * @return the traversal with an appended {@link GraphStep} + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#graph-step"; target="_blank">Reference Documentation - Graph Step</a> */ public default GraphTraversal<S, Vertex> V(final Object... vertexIdsOrElements) { @@ -300,6 +309,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param direction the direction to traverse from the current vertex * @param edgeLabels the edge labels to traverse * @return the traversal with an appended {@link VertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> to(final Direction direction, final String... edgeLabels) { @@ -312,6 +322,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param edgeLabels the edge labels to traverse * @return the traversal with an appended {@link VertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> out(final String... edgeLabels) { @@ -324,6 +335,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param edgeLabels the edge labels to traverse * @return the traversal with an appended {@link VertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> in(final String... edgeLabels) { @@ -336,6 +348,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param edgeLabels the edge labels to traverse * @return the traversal with an appended {@link VertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> both(final String... edgeLabels) { @@ -349,6 +362,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param direction the direction to traverse from the current vertex * @param edgeLabels the edge labels to traverse * @return the traversal with an appended {@link VertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Edge> toE(final Direction direction, final String... edgeLabels) { @@ -361,6 +375,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param edgeLabels the edge labels to traverse * @return the traversal with an appended {@link VertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Edge> outE(final String... edgeLabels) { @@ -373,6 +388,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param edgeLabels the edge labels to traverse * @return the traversal with an appended {@link VertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Edge> inE(final String... edgeLabels) { @@ -385,6 +401,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param edgeLabels the edge labels to traverse * @return the traversal with an appended {@link VertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Edge> bothE(final String... edgeLabels) { @@ -397,6 +414,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param direction the direction to traverser from the current edge * @return the traversal with an appended {@link EdgeVertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> toV(final Direction direction) { @@ -408,6 +426,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Edge} to its incoming/head incident {@link Vertex}. * * @return the traversal with an appended {@link EdgeVertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> inV() { @@ -419,6 +438,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Edge} to its outgoing/tail incident {@link Vertex}. * * @return the traversal with an appended {@link EdgeVertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> outV() { @@ -430,6 +450,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Edge} to its incident vertices. * * @return the traversal with an appended {@link EdgeVertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> bothV() { @@ -441,6 +462,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Edge} to the incident vertex that was not just traversed from in the path history. * * @return the traversal with an appended {@link EdgeOtherVertexStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#vertex-steps"; target="_blank">Reference Documentation - Vertex Step</a> */ public default GraphTraversal<S, Vertex> otherV() { @@ -452,6 +474,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Order all the objects in the traversal up to this point and then emit them one-by-one in their ordered sequence. * * @return the traversal with an appended {@link OrderGlobalStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#order-step"; target="_blank">Reference Documentation - Order Step</a> */ public default GraphTraversal<S, E> order() { @@ -463,7 +486,8 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Order either the {@link Scope#local} object (e.g. a list, map, etc.) or the entire {@link Scope#global} traversal stream. * * @param scope whether the ordering is the current local object or the entire global stream. - * @return the traversal with an appended {@link OrderGlobalStep} or {@link OrderLocalStep}. + * @return the traversal with an appended {@link OrderGlobalStep} or {@link OrderLocalStep} depending on the {@code scope}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#order-step"; target="_blank">Reference Documentation - Order Step</a> */ public default GraphTraversal<S, E> order(final Scope scope) { @@ -478,6 +502,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve * @param <E2> the value type of the returned properties * @return the traversal with an appended {@link PropertiesStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#properties-step"; target="_blank">Reference Documentation - Properties Step</a> */ public default <E2> GraphTraversal<S, ? extends Property<E2>> properties(final String... propertyKeys) { @@ -492,6 +517,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve their value from * @param <E2> the value type of the properties * @return the traversal with an appended {@link PropertiesStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#values-step"; target="_blank">Reference Documentation - Values Step</a> */ public default <E2> GraphTraversal<S, E2> values(final String... propertyKeys) { @@ -506,6 +532,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve * @param <E2> the value type of the returned properties * @return the traversal with an appended {@link PropertyMapStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#propertymap-step"; target="_blank">Reference Documentation - PropertyMap Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> propertyMap(final String... propertyKeys) { @@ -520,6 +547,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve * @param <E2> the value type of the returned properties * @return the traversal with an appended {@link PropertyMapStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#valuemap-step"; target="_blank">Reference Documentation - ValueMap Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> valueMap(final String... propertyKeys) { @@ -535,6 +563,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve * @param <E2> the value type of the returned properties * @return the traversal with an appended {@link PropertyMapStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#valuemap-step"; target="_blank">Reference Documentation - ValueMap Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> valueMap(final boolean includeTokens, final String... propertyKeys) { @@ -543,6 +572,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** + * @since 3.0.0-incubating * @deprecated As of release 3.1.0, replaced by {@link GraphTraversal#select(Column)} */ @Deprecated @@ -551,6 +581,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** + * @since 3.0.0-incubating * @deprecated As of release 3.1.0, replaced by {@link GraphTraversal#select(Column)} */ @Deprecated @@ -562,6 +593,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Property} to its {@link Property#key}. * * @return the traversal with an appended {@link PropertyKeyStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#key-step"; target="_blank">Reference Documentation - Key Step</a> */ public default GraphTraversal<S, String> key() { @@ -573,6 +605,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Property} to its {@link Property#value}. * * @return the traversal with an appended {@link PropertyValueStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#value-step"; target="_blank">Reference Documentation - Value Step</a> */ public default <E2> GraphTraversal<S, E2> value() { @@ -584,6 +617,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Map the {@link Traverser} to its {@link Path} history via {@link Traverser#path}. * * @return the traversal with an appended {@link PathStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#path-step"; target="_blank">Reference Documentation - Path Step</a> */ public default GraphTraversal<S, Path> path() { @@ -597,6 +631,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param matchTraversals the traversal that maintain variables which must hold for the life of the traverser * @param <E2> the type of the obejcts bound in the variables * @return the traversal with an appended {@link MatchStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#match-step"; target="_blank">Reference Documentation - Match Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> match(final Traversal<?, ?>... matchTraversals) { @@ -609,6 +644,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param <E2> the sack value type * @return the traversal with an appended {@link SackStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#sack-step"; target="_blank">Reference Documentation - Sack Step</a> */ public default <E2> GraphTraversal<S, E2> sack() { @@ -621,6 +657,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * traverser. * * @return the traversal with an appended {@link LoopsStep} + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#loops-step"; target="_blank">Reference Documentation - Loops Step</a> */ public default GraphTraversal<S, Integer> loops() { @@ -632,6 +669,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Projects the current object in the stream into a {@code Map} that is keyed by the provided labels. * * @return the traversal with an appended {@link ProjectStep} + * @since 3.2.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#project-step"; target="_blank">Reference Documentation - Project Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> project(final String projectKey, final String... otherProjectKeys) { @@ -651,6 +689,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param otherSelectKeys the third+ keys to project * @param <E2> the type of the objects projected * @return the traversal with an appended {@link SelectStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#select-step"; target="_blank">Reference Documentation - Select Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> select(final Pop pop, final String selectKey1, final String selectKey2, String... otherSelectKeys) { @@ -670,6 +709,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param otherSelectKeys the third+ keys to project * @param <E2> the type of the objects projected * @return the traversal with an appended {@link SelectStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#select-step"; target="_blank">Reference Documentation - Select Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> select(final String selectKey1, final String selectKey2, String... otherSelectKeys) { @@ -687,6 +727,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param selectKey the key to project * @return the traversal with an appended {@link SelectStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#select-step"; target="_blank">Reference Documentation - Select Step</a> */ public default <E2> GraphTraversal<S, E2> select(final Pop pop, final String selectKey) { @@ -701,6 +742,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param selectKey the key to project * @return the traversal with an appended {@link SelectStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#select-step"; target="_blank">Reference Documentation - Select Step</a> */ public default <E2> GraphTraversal<S, E2> select(final String selectKey) { @@ -713,6 +755,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param column the column to extract * @return the traversal with an appended {@link TraversalMapStep} + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#select-step"; target="_blank">Reference Documentation - Select Step</a> */ public default <E2> GraphTraversal<S, Collection<E2>> select(final Column column) { @@ -725,6 +768,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * is not one of those types. * * @return the traversal with an appended {@link UnfoldStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#unfold-step"; target="_blank">Reference Documentation - Unfold Step</a> */ public default <E2> GraphTraversal<S, E2> unfold() { @@ -736,6 +780,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Rolls up objects in the stream into an aggregate list. * * @return the traversal with an appended {@link FoldStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#fold-step"; target="_blank">Reference Documentation - Fold Step</a> */ public default GraphTraversal<S, List<E>> fold() { @@ -750,6 +795,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param foldFunction the function to fold by where the first argument is the {@code seed} or the value returned from subsequent calss and * the second argument is the value from the stream * @return the traversal with an appended {@link FoldStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#fold-step"; target="_blank">Reference Documentation - Fold Step</a> */ public default <E2> GraphTraversal<S, E2> fold(final E2 seed, final BiFunction<E2, E, E2> foldFunction) { @@ -762,6 +808,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * of traversers up to this point). * * @return the traversal with an appended {@link CountGlobalStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#count-step"; target="_blank">Reference Documentation - Count Step</a> */ public default GraphTraversal<S, Long> count() { @@ -774,6 +821,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * {@link Scope} (i.e. count the number of traversers up to this point). * * @return the traversal with an appended {@link CountGlobalStep} or {@link CountLocalStep} depending on the {@link Scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#count-step"; target="_blank">Reference Documentation - Count Step</a> */ public default GraphTraversal<S, Long> count(final Scope scope) { @@ -786,6 +834,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * {@link Traverser#bulk} (i.e. sum the traverser values up to this point). * * @return the traversal with an appended {@link SumGlobalStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#sum-step"; target="_blank">Reference Documentation - Sum Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> sum() { @@ -798,6 +847,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * {@link Traverser#bulk} given the specified {@link Scope} (i.e. sum the traverser values up to this point). * * @return the traversal with an appended {@link SumGlobalStep} or {@link SumLocalStep} depending on the {@link Scope}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#sum-step"; target="_blank">Reference Documentation - Sum Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> sum(final Scope scope) { @@ -809,6 +859,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Determines the largest value in the stream. * * @return the traversal with an appended {@link MaxGlobalStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#max-step"; target="_blank">Reference Documentation - Max Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> max() { @@ -820,6 +871,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Determines the largest value in the stream given the {@link Scope}. * * @return the traversal with an appended {@link MaxGlobalStep} or {@link MaxLocalStep} depending on the {@link Scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#max-step"; target="_blank">Reference Documentation - Max Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> max(final Scope scope) { @@ -831,6 +883,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Determines the smallest value in the stream. * * @return the traversal with an appended {@link MinGlobalStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#min-step"; target="_blank">Reference Documentation - Min Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> min() { @@ -842,6 +895,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Determines the smallest value in the stream given the {@link Scope}. * * @return the traversal with an appended {@link MinGlobalStep} or {@link MinLocalStep} depending on the {@link Scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#min-step"; target="_blank">Reference Documentation - Min Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> min(final Scope scope) { @@ -853,6 +907,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Determines the mean value in the stream. * * @return the traversal with an appended {@link MeanGlobalStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#mean-step"; target="_blank">Reference Documentation - Mean Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> mean() { @@ -864,6 +919,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Determines the mean value in the stream given the {@link Scope}. * * @return the traversal with an appended {@link MeanGlobalStep} or {@link MeanLocalStep} depending on the {@link Scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#mean-step"; target="_blank">Reference Documentation - Mean Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> mean(final Scope scope) { @@ -876,6 +932,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * {@link #by()} modulators which help specify how the grouping should occur. * * @return the traversal with an appended {@link GroupStep}. + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#group-step"; target="_blank">Reference Documentation - Group Step</a> */ public default <K, V> GraphTraversal<S, Map<K, V>> group() { @@ -885,6 +942,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { /** * @deprecated As of release 3.1.0, replaced by {@link #group()} + * @since 3.0.0-incubating */ @Deprecated public default <K, V> GraphTraversal<S, Map<K, V>> groupV3d0() { @@ -897,6 +955,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * object is the key and the value is the count. * * @return the traversal with an appended {@link GroupCountStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#groupcount-step"; target="_blank">Reference Documentation - GroupCount Step</a> */ public default <K> GraphTraversal<S, Map<K, Long>> groupCount() { @@ -908,6 +967,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Aggregates the emanating paths into a {@link Tree} data structure. * * @return the traversal with an appended {@link TreeStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#tree-step"; target="_blank">Reference Documentation - Tree Step</a> */ public default GraphTraversal<S, Tree> tree() { @@ -920,6 +980,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param vertexLabel the label of the {@link Vertex} to add * @return the traversal with the {@link AddVertexStep} added + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addvertex-step"; target="_blank">Reference Documentation - AddVertex Step</a> */ public default GraphTraversal<S, Vertex> addV(final String vertexLabel) { @@ -931,6 +992,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Adds a {@link Vertex} with a default vertex label. * * @return the traversal with the {@link AddVertexStep} added + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addvertex-step"; target="_blank">Reference Documentation - AddVertex Step</a> */ public default GraphTraversal<S, Vertex> addV() { @@ -939,6 +1001,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** + * @since 3.0.0-incubating * @deprecated As of release 3.1.0, replaced by {@link #addV()} */ @Deprecated @@ -956,6 +1019,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param edgeLabel the label of the newly added edge * @return the traversal with the {@link AddEdgeStep} added + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> */ public default GraphTraversal<S, Edge> addE(final String edgeLabel) { @@ -969,6 +1033,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param toStepLabel the step label of the incoming vertex * @return the traversal with the modified {@link AddEdgeStep} + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> */ public default GraphTraversal<S, E> to(final String toStepLabel) { @@ -983,6 +1048,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param fromStepLabel the step label of the outgoing vertex * @return the traversal with the modified {@link AddEdgeStep} + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> */ public default GraphTraversal<S, E> from(final String fromStepLabel) { @@ -997,6 +1063,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param toVertex the traversal for selecting the incoming vertex * @return the traversal with the modified {@link AddEdgeStep} + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> */ public default GraphTraversal<S, E> to(final Traversal<E, Vertex> toVertex) { @@ -1011,6 +1078,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param fromVertex the traversal for selecting the outgoing vertex * @return the traversal with the modified {@link AddEdgeStep} + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> */ public default GraphTraversal<S, E> from(final Traversal<E, Vertex> fromVertex) { @@ -1020,6 +1088,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** + * @since 3.0.0-incubating * @deprecated As of release 3.1.0, replaced by {@link #addE(String)} */ @Deprecated @@ -1054,6 +1123,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** + * @since 3.0.0-incubating * @deprecated As of release 3.1.0, replaced by {@link #addE(String)} */ @Deprecated @@ -1062,6 +1132,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** + * @since 3.0.0-incubating * @deprecated As of release 3.1.0, replaced by {@link #addE(String)} */ @Deprecated @@ -1077,6 +1148,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param predicate the filter function to apply * @return the traversal with the {@link LambdaFilterStep} added + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default GraphTraversal<S, E> filter(final Predicate<Traverser<E>> predicate) { @@ -1090,6 +1162,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param filterTraversal the filter traversal to apply * @return the traversal with the {@link TraversalFilterStep} added + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default GraphTraversal<S, E> filter(final Traversal<?, ?> filterTraversal) { @@ -1102,6 +1175,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param orTraversals filter traversals where at least one must be satisfied * @return the traversal with an appended {@link OrStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#or-step"; target="_blank">Reference Documentation - Or Step</a> */ public default GraphTraversal<S, E> or(final Traversal<?, ?>... orTraversals) { @@ -1114,6 +1188,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param andTraversals filter traversals that must be satisfied * @return the traversal with an appended {@link AndStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#and-step"; target="_blank">Reference Documentation - And Step</a> */ public default GraphTraversal<S, E> and(final Traversal<?, ?>... andTraversals) { @@ -1126,6 +1201,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param injections the objects to add to the stream * @return the traversal with an appended {@link InjectStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#inject-step"; target="_blank">Reference Documentation - Inject Step</a> * */ @@ -1140,6 +1216,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param scope whether the deduplication is on the stream (global) or the current object (local). * @param dedupLabels if labels are provided, then the scope labels determine de-duplication. No labels implies current object. * @return the traversal with an appended {@link DedupGlobalStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#dedup-step"; target="_blank">Reference Documentation - Dedup Step</a> */ public default GraphTraversal<S, E> dedup(final Scope scope, final String... dedupLabels) { @@ -1152,6 +1229,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param dedupLabels if labels are provided, then the scoped object's labels determine de-duplication. No labels implies current object. * @return the traversal with an appended {@link DedupGlobalStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#dedup-step"; target="_blank">Reference Documentation - Dedup Step</a> */ public default GraphTraversal<S, E> dedup(final String... dedupLabels) { @@ -1165,6 +1243,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param startKey the key containing the object to filter * @param predicate the filter to apply * @return the traversal with an appended {@link WherePredicateStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#where-step"; target="_blank">Reference Documentation - Where Step</a> * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#using-where-with-match"; target="_blank">Reference Documentation - Where with Match</a> * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#using-where-with-select"; target="_blank">Reference Documentation - Where with Select</a> @@ -1179,6 +1258,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param predicate the filter to apply * @return the traversal with an appended {@link WherePredicateStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#where-step"; target="_blank">Reference Documentation - Where Step</a> * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#using-where-with-match"; target="_blank">Reference Documentation - Where with Match</a> * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#using-where-with-select"; target="_blank">Reference Documentation - Where with Select</a> @@ -1193,6 +1273,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param whereTraversal the filter to apply * @return the traversal with an appended {@link WherePredicateStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#where-step"; target="_blank">Reference Documentation - Where Step</a> * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#using-where-with-match"; target="_blank">Reference Documentation - Where with Match</a> * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#using-where-with-select"; target="_blank">Reference Documentation - Where with Select</a> @@ -1210,6 +1291,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKey the key of the property to filter on * @param predicate the filter to apply to the key's value * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final String propertyKey, final P<?> predicate) { @@ -1223,6 +1305,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param accessor the {@link T} accessor of the property to filter on * @param predicate the filter to apply to the key's value * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final T accessor, final P<?> predicate) { @@ -1236,6 +1319,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKey the key of the property to filter on * @param value the value to compare the property value to for equality * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final String propertyKey, final Object value) { @@ -1255,6 +1339,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param accessor the {@link T} accessor of the property to filter on * @param value the value to compare the accessor value to for equality * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final T accessor, final Object value) { @@ -1275,6 +1360,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKey the key of the property to filter on * @param predicate the filter to apply to the key's value * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final String label, final String propertyKey, final P<?> predicate) { @@ -1290,6 +1376,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKey the key of the property to filter on * @param value the value to compare the accessor value to for equality * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final String label, final String propertyKey, final Object value) { @@ -1304,6 +1391,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param accessor the {@link T} accessor of the property to filter on * @param propertyTraversal the traversal to filter the accessor value by * @return the traversal with an appended {@link HasStep} + * @since 3.1.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final T accessor, final Traversal<?, ?> propertyTraversal) { @@ -1319,6 +1407,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKey the key of the property to filter on * @param propertyTraversal the traversal to filter the property value by * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final String propertyKey, final Traversal<?, ?> propertyTraversal) { @@ -1333,6 +1422,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param propertyKey the key of the property to filter on for existence * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> has(final String propertyKey) { @@ -1345,6 +1435,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param propertyKey the key of the property to filter on for existence * @return the traversal with an appended {@link HasStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> hasNot(final String propertyKey) { @@ -1358,6 +1449,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param label the label of the {@link Element} * @param otherLabels additional labels of the {@link Element} * @return the traversal with an appended {@link HasStep} + * @since 3.2.2 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> hasLabel(final String label, final String... otherLabels) { @@ -1373,6 +1465,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param predicate the filter to apply to the label of the {@link Element} * @return the traversal with an appended {@link HasStep} + * @since 3.2.4 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> hasLabel(final P<String> predicate) { @@ -1386,6 +1479,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param id the identifier of the {@link Element} * @param otherIds additional identifiers of the {@link Element} * @return the traversal with an appended {@link HasStep} + * @since 3.2.2 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> hasId(final Object id, final Object... otherIds) { @@ -1417,6 +1511,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param predicate the filter to apply to the identifier of the {@link Element} * @return the traversal with an appended {@link HasStep} + * @since 3.2.4 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> hasId(final P<Object> predicate) { @@ -1430,6 +1525,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param label the key of the {@link Element} * @param otherLabels additional key of the {@link Element} * @return the traversal with an appended {@link HasStep} + * @since 3.2.2 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> hasKey(final String label, final String... otherLabels) { @@ -1445,6 +1541,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param predicate the filter to apply to the key of the {@link Element} * @return the traversal with an appended {@link HasStep} + * @since 3.2.4 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> hasKey(final P<String> predicate) { @@ -1489,6 +1586,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param predicate the filter to apply to the value of the {@link Element} * @return the traversal with an appended {@link HasStep} + * @since 3.2.4 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#has-step"; target="_blank">Reference Documentation - Has Step</a> */ public default GraphTraversal<S, E> hasValue(final P<Object> predicate) { @@ -1501,6 +1599,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param predicate the filter to apply * @return the traversal with an appended {@link IsStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#is-step"; target="_blank">Reference Documentation - Is Step</a> */ public default GraphTraversal<S, E> is(final P<E> predicate) { @@ -1513,6 +1612,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param value the value that the object must equal. * @return the traversal with an appended {@link IsStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#is-step"; target="_blank">Reference Documentation - Is Step</a> */ public default GraphTraversal<S, E> is(final Object value) { @@ -1525,6 +1625,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param notTraversal the traversal to filter by. * @return the traversal with an appended {@link NotStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#not-step"; target="_blank">Reference Documentation - Not Step</a> */ public default GraphTraversal<S, E> not(final Traversal<?, ?> notTraversal) { @@ -1537,6 +1638,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param probability the probability that the object will pass through * @return the traversal with an appended {@link CoinStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#coin-step"; target="_blank">Reference Documentation - Coin Step</a> */ public default GraphTraversal<S, E> coin(final double probability) { @@ -1551,6 +1653,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param low the number at which to start allowing objects through the stream * @param high the number at which to end the stream * @return the traversal with an appended {@link RangeGlobalStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#range-step"; target="_blank">Reference Documentation - Range Step</a> */ public default GraphTraversal<S, E> range(final long low, final long high) { @@ -1567,6 +1670,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param low the number at which to start allowing objects through the stream * @param high the number at which to end the stream * @return the traversal with an appended {@link RangeGlobalStep} or {@link RangeLocalStep} depending on {@code scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#range-step"; target="_blank">Reference Documentation - Range Step</a> */ public default <E2> GraphTraversal<S, E2> range(final Scope scope, final long low, final long high) { @@ -1582,6 +1686,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param limit the number at which to end the stream * @return the traversal with an appended {@link RangeGlobalStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#limit-step"; target="_blank">Reference Documentation - Limit Step</a> */ public default GraphTraversal<S, E> limit(final long limit) { @@ -1596,6 +1701,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param scope the scope of how to apply the {@code limit} * @param limit the number at which to end the stream * @return the traversal with an appended {@link RangeGlobalStep} or {@link RangeLocalStep} depending on {@code scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#limit-step"; target="_blank">Reference Documentation - Limit Step</a> */ public default <E2> GraphTraversal<S, E2> limit(final Scope scope, final long limit) { @@ -1610,6 +1716,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * object will be returned. * * @return the traversal with an appended {@link TailGlobalStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#tail-step"; target="_blank">Reference Documentation - Tail Step</a> */ public default GraphTraversal<S, E> tail() { @@ -1623,6 +1730,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param limit the number at which to end the stream * @return the traversal with an appended {@link TailGlobalStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#tail-step"; target="_blank">Reference Documentation - Tail Step</a> */ public default GraphTraversal<S, E> tail(final long limit) { @@ -1636,6 +1744,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param scope the scope of how to apply the {@code tail} * @return the traversal with an appended {@link TailGlobalStep} or {@link TailLocalStep} depending on {@code scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#tail-step"; target="_blank">Reference Documentation - Tail Step</a> */ public default <E2> GraphTraversal<S, E2> tail(final Scope scope) { @@ -1652,6 +1761,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param scope the scope of how to apply the {@code tail} * @param limit the number at which to end the stream * @return the traversal with an appended {@link TailGlobalStep} or {@link TailLocalStep} depending on {@code scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#tail-step"; target="_blank">Reference Documentation - Tail Step</a> */ public default <E2> GraphTraversal<S, E2> tail(final Scope scope, final long limit) { @@ -1666,6 +1776,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param timeLimit the count down time * @return the traversal with an appended {@link TimeLimitStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#timelimit-step"; target="_blank">Reference Documentation - TimeLimit Step</a> */ public default GraphTraversal<S, E> timeLimit(final long timeLimit) { @@ -1677,6 +1788,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Filter the <code>E</code> object if its {@link Traverser#path} is not {@link Path#isSimple}. * * @return the traversal with an appended {@link SimplePathStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#simplepath-step"; target="_blank">Reference Documentation - SimplePath Step</a> */ public default GraphTraversal<S, E> simplePath() { @@ -1688,6 +1800,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Filter the <code>E</code> object if its {@link Traverser#path} is {@link Path#isSimple}. * * @return the traversal with an appended {@link CyclicPathStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#cyclicpath-step"; target="_blank">Reference Documentation - CyclicPath Step</a> */ public default GraphTraversal<S, E> cyclicPath() { @@ -1700,6 +1813,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param amountToSample the number of objects to allow * @return the traversal with an appended {@link SampleGlobalStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#sample-step"; target="_blank">Reference Documentation - Sample Step</a> */ public default GraphTraversal<S, E> sample(final int amountToSample) { @@ -1713,6 +1827,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param scope the scope of how to apply the {@code sample} * @param amountToSample the number of objects to allow * @return the traversal with an appended {@link SampleGlobalStep} or {@link SampleLocalStep} depending on the {@code scope} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#sample-step"; target="_blank">Reference Documentation - Sample Step</a> */ public default GraphTraversal<S, E> sample(final Scope scope, final int amountToSample) { @@ -1728,6 +1843,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * to actually take place. In most cases, iteration is best accomplished with {@code g.V().drop().iterate()}. * * @return the traversal with the {@link DropStep} added + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#drop-step"; target="_blank">Reference Documentation - Drop Step</a> */ public default GraphTraversal<S, E> drop() { @@ -1742,6 +1858,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param consumer the operation to perform at this step in relation to the {@link Traverser} * @return the traversal with an appended {@link LambdaSideEffectStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default GraphTraversal<S, E> sideEffect(final Consumer<Traverser<E>> consumer) { @@ -1754,6 +1871,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sideEffectTraversal the operation to perform at this step in relation to the {@link Traverser} * @return the traversal with an appended {@link TraversalSideEffectStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default GraphTraversal<S, E> sideEffect(final Traversal<?, ?> sideEffectTraversal) { @@ -1768,6 +1886,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param sideEffectKey the side-effect to emit * @param sideEffectKeys other side-effects to emit * @return the traversal with an appended {@link SideEffectCapStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#cap-step"; target="_blank">Reference Documentation - Cap Step</a> */ public default <E2> GraphTraversal<S, E2> cap(final String sideEffectKey, final String... sideEffectKeys) { @@ -1781,6 +1900,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sideEffectKey the name of the side-effect key that will hold the subgraph * @return the traversal with an appended {@link SubgraphStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#subgraph-step"; target="_blank">Reference Documentation - Subgraph Step</a> */ public default GraphTraversal<S, Edge> subgraph(final String sideEffectKey) { @@ -1793,6 +1913,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sideEffectKey the name of the side-effect key that will hold the aggregated objects * @return the traversal with an appended {@link AggregateStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#aggregate-step"; target="_blank">Reference Documentation - Aggregate Step</a> */ public default GraphTraversal<S, E> aggregate(final String sideEffectKey) { @@ -1806,6 +1927,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sideEffectKey the name of the side-effect key that will hold the aggregated grouping * @return the traversal with an appended {@link GroupStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#group-step"; target="_blank">Reference Documentation - Group Step</a> */ public default GraphTraversal<S, E> group(final String sideEffectKey) { @@ -1814,6 +1936,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** + * @since 3.0.0-incubating * @deprecated As of release 3.1.0, replaced by {@link #group(String)}. */ public default GraphTraversal<S, E> groupV3d0(final String sideEffectKey) { @@ -1827,6 +1950,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sideEffectKey the name of the side-effect key that will hold the aggregated grouping * @return the traversal with an appended {@link GroupCountStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#groupcount-step"; target="_blank">Reference Documentation - GroupCount Step</a> */ public default GraphTraversal<S, E> groupCount(final String sideEffectKey) { @@ -1839,6 +1963,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sideEffectKey the name of the side-effect key that will hold the tree * @return the traversal with an appended {@link TreeStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#tree-step"; target="_blank">Reference Documentation - Tree Step</a> */ public default GraphTraversal<S, E> tree(final String sideEffectKey) { @@ -1851,6 +1976,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sackOperator the operator to apply to the sack value * @return the traversal with an appended {@link SackStep}. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#sack-step"; target="_blank">Reference Documentation - Sack Step</a> */ public default <V, U> GraphTraversal<S, E> sack(final BiFunction<V, U, V> sackOperator) { @@ -1859,6 +1985,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** + * @since 3.0.0-incubating * @deprecated As of release 3.1.0, replaced by {@link #sack(BiFunction)} with {@link #by(String)}. */ @Deprecated @@ -1871,6 +1998,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sideEffectKey the name of the side-effect key that will hold the aggregate * @return the traversal with an appended {@link StoreStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#store-step"; target="_blank">Reference Documentation - Store Step</a> */ public default GraphTraversal<S, E> store(final String sideEffectKey) { @@ -1884,6 +2012,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param sideEffectKey the name of the side-effect key within which to hold the profile object * @return the traversal with an appended {@link ProfileSideEffectStep} + * @since 3.2.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#profile-step"; target="_blank">Reference Documentation - Profile Step</a> */ public default GraphTraversal<S, E> profile(final String sideEffectKey) { @@ -1896,6 +2025,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * counts, etc. * * @return the traversal with an appended {@link ProfileSideEffectStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#profile-step"; target="_blank">Reference Documentation - Profile Step</a> */ @Override @@ -1919,6 +2049,8 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param key the key for the property * @param value the value for the property * @param keyValues any meta properties to be assigned to this property + * @return the traversal with the last step modified to add a property + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addproperty-step"; target="_blank">AddProperty Step</a> */ public default GraphTraversal<S, E> property(final VertexProperty.Cardinality cardinality, final Object key, final Object value, final Object... keyValues) { @@ -1951,6 +2083,8 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param key the key for the property * @param value the value for the property * @param keyValues any meta properties to be assigned to this property + * @return the traversal with the last step modified to add a property + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addproperty-step"; target="_blank">AddProperty Step</a> */ public default GraphTraversal<S, E> property(final Object key, final Object value, final Object... keyValues) { @@ -1969,6 +2103,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param branchTraversal the traversal to branch the {@link Traverser} to * @return the {@link Traversal} with the {@link BranchStep} added + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default <M, E2> GraphTraversal<S, E2> branch(final Traversal<?, M> branchTraversal) { @@ -1983,6 +2118,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param function the traversal to branch the {@link Traverser} to * @return the {@link Traversal} with the {@link BranchStep} added + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#general-steps"; target="_blank">Reference Documentation - General Steps</a> */ public default <M, E2> GraphTraversal<S, E2> branch(final Function<Traverser<E>, M> function) { @@ -1999,6 +2135,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param choiceTraversal the traversal used to determine the value for the branch * @return the traversal with the appended {@link ChooseStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#choose-step"; target="_blank">Reference Documentation - Choose Step</a> */ public default <M, E2> GraphTraversal<S, E2> choose(final Traversal<?, M> choiceTraversal) { @@ -2014,6 +2151,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param trueChoice the traversal to execute in the event the {@code traversalPredicate} returns true * @param falseChoice the traversal to execute in the event the {@code traversalPredicate} returns false * @return the traversal with the appended {@link ChooseStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#choose-step"; target="_blank">Reference Documentation - Choose Step</a> */ public default <E2> GraphTraversal<S, E2> choose(final Traversal<?, ?> traversalPredicate, @@ -2029,6 +2167,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param traversalPredicate the traversal used to determine the "if" portion of the if-then-else * @param trueChoice the traversal to execute in the event the {@code traversalPredicate} returns true * @return the traversal with the appended {@link ChooseStep} + * @since 3.2.4 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#choose-step"; target="_blank">Reference Documentation - Choose Step</a> */ public default <E2> GraphTraversal<S, E2> choose(final Traversal<?, ?> traversalPredicate, @@ -2044,6 +2183,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param choiceFunction the function used to determine the value for the branch * @return the traversal with the appended {@link ChooseStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#choose-step"; target="_blank">Reference Documentation - Choose Step</a> */ public default <M, E2> GraphTraversal<S, E2> choose(final Function<E, M> choiceFunction) { @@ -2059,6 +2199,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param trueChoice the traversal to execute in the event the {@code traversalPredicate} returns true * @param falseChoice the traversal to execute in the event the {@code traversalPredicate} returns false * @return the traversal with the appended {@link ChooseStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#choose-step"; target="_blank">Reference Documentation - Choose Step</a> */ public default <E2> GraphTraversal<S, E2> choose(final Predicate<E> choosePredicate, @@ -2074,6 +2215,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param choosePredicate the function used to determine the "if" portion of the if-then-else * @param trueChoice the traversal to execute in the event the {@code traversalPredicate} returns true * @return the traversal with the appended {@link ChooseStep} + * @since 3.2.4 * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#choose-step"; target="_blank">Reference Documentation - Choose Step</a> */ public default <E2> GraphTraversal<S, E2> choose(final Predicate<E> choosePredicate, @@ -2087,6 +2229,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param optionalTraversal the traversal to execute for a potential result * @return the traversal with the appended {@link ChooseStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#optional-step"; target="_blank">Reference Documentation - Optional Step</a> */ public default <E2> GraphTraversal<S, E2> optional(final Traversal<?, E2> optionalTraversal) { @@ -2099,6 +2242,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param unionTraversals the traversals to merge * @return the traversal with the appended {@link UnionStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#union-step"; target="_blank">Reference Documentation - Union Step</a> */ public default <E2> GraphTraversal<S, E2> union(final Traversal<?, E2>... unionTraversals) { @@ -2111,6 +2255,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param coalesceTraversals the traversals to coalesce * @return the traversal with the appended {@link CoalesceStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#coalesce-step"; target="_blank">Reference Documentation - Coalesce Step</a> */ public default <E2> GraphTraversal<S, E2> coalesce(final Traversal<?, E2>... coalesceTraversals) { @@ -2123,6 +2268,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param repeatTraversal the traversal to repeat over * @return the traversal with the appended {@link RepeatStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#repeat-step"; target="_blank">Reference Documentation - Repeat Step</a> */ public default GraphTraversal<S, E> repeat(final Traversal<?, E> repeatTraversal) { @@ -2135,6 +2281,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param emitTraversal the emit predicate defined as a traversal * @return the traversal with the appended {@link RepeatStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#repeat-step"; target="_blank">Reference Documentation - Repeat Step</a> */ public default GraphTraversal<S, E> emit(final Traversal<?, ?> emitTraversal) { @@ -2147,6 +2294,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param emitPredicate the emit predicate * @return the traversal with the appended {@link RepeatStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#repeat-step"; target="_blank">Reference Documentation - Repeat Step</a> */ public default GraphTraversal<S, E> emit(final Predicate<Traverser<E>> emitPredicate) { @@ -2158,6 +2306,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Emit is used in conjunction with {@link #repeat(Traversal)} to emit all objects from the loop. * * @return the traversal with the appended {@link RepeatStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#repeat-step"; target="_blank">Reference Documentation - Repeat Step</a> */ public default GraphTraversal<S, E> emit() { @@ -2170,6 +2319,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param untilTraversal the traversal that determines when the loop exits * @return the traversal with the appended {@link RepeatStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#repeat-step"; target="_blank">Reference Documentation - Repeat Step</a> */ public default GraphTraversal<S, E> until(final Traversal<?, ?> untilTraversal) { @@ -2182,6 +2332,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param untilPredicate the predicate that determines when the loop exits * @return the traversal with the appended {@link RepeatStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#repeat-step"; target="_blank">Reference Documentation - Repeat Step</a> */ public default GraphTraversal<S, E> until(final Predicate<Traverser<E>> untilPredicate) { @@ -2194,6 +2345,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param maxLoops the number of loops to execute prior to exiting * @return the traversal with the appended {@link RepeatStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#repeat-step"; target="_blank">Reference Documentation - Repeat Step</a> */ public default GraphTraversal<S, E> times(final int maxLoops) { @@ -2210,6 +2362,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param localTraversal the traversal to execute locally * @return the traversal with the appended {@link LocalStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#local-step"; target="_blank">Reference Documentation - Local Step</a> */ public default <E2> GraphTraversal<S, E2> local(final Traversal<?, E2> localTraversal) { @@ -2223,6 +2376,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Calculates a PageRank over the graph using a 0.85 for the {@code alpha} value. * * @return the traversal with the appended {@link PageRankVertexProgramStep} + * @since 3.2.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#pagerank-step"; target="_blank">Reference Documentation - PageRank Step</a> */ public default GraphTraversal<S, E> pageRank() { @@ -2233,6 +2387,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Calculates a PageRank over the graph. * * @return the traversal with the appended {@link PageRankVertexProgramStep} + * @since 3.2.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#pagerank-step"; target="_blank">Reference Documentation - PageRank Step</a> */ public default GraphTraversal<S, E> pageRank(final double alpha) { @@ -2244,6 +2399,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Executes a Peer Pressure community detection algorithm over the graph. * * @return the traversal with the appended {@link PeerPressureVertexProgramStep} + * @since 3.2.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step"; target="_blank">Reference Documentation - PeerPressure Step</a> */ public default GraphTraversal<S, E> peerPressure() { @@ -2255,6 +2411,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Executes a Peer Pressure community detection algorithm over the graph. * * @return the traversal with the appended {@link PeerPressureVertexProgramStep} + * @since 3.2.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step"; target="_blank">Reference Documentation - PeerPressure Step</a> */ public default GraphTraversal<S, E> program(final VertexProgram<?> vertexProgram) { @@ -2269,6 +2426,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param stepLabel the name of the step * @param stepLabels additional names for the label * @return the traversal with the modified end step + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#as-step"; target="_blank">Reference Documentation - As Step</a> */ public default GraphTraversal<S, E> as(final String stepLabel, final String... stepLabels) { @@ -2288,6 +2446,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * {@code Integer.MAX_VALUE}. * * @return the traversal with an appended {@link NoOpBarrierStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#barrier-step"; target="_blank">Reference Documentation - Barrier Step</a> */ public default GraphTraversal<S, E> barrier() { @@ -2300,6 +2459,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param maxBarrierSize the size of the barrier * @return the traversal with an appended {@link NoOpBarrierStep} + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#barrier-step"; target="_blank">Reference Documentation - Barrier Step</a> */ public default GraphTraversal<S, E> barrier(final int maxBarrierSize) { @@ -2314,6 +2474,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param barrierConsumer a consumer function that is applied to the objects aggregated to the barrier * @return the traversal with an appended {@link NoOpBarrierStep} + * @since 3.2.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#barrier-step"; target="_blank">Reference Documentation - Barrier Step</a> */ public default GraphTraversal<S, E> barrier(final Consumer<TraverserSet<Object>> barrierConsumer) { @@ -2329,6 +2490,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * an {@link #identity()} modulation. * * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default GraphTraversal<S, E> by() { @@ -2343,6 +2505,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param traversal the traversal to apply * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default GraphTraversal<S, E> by(final Traversal<?, ?> traversal) { @@ -2357,6 +2520,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param token the token to apply * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default GraphTraversal<S, E> by(final T token) { @@ -2371,6 +2535,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param key the key to apply * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default GraphTraversal<S, E> by(final String key) { @@ -2385,6 +2550,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param function the function to apply * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default <V> GraphTraversal<S, E> by(final Function<V, Object> function) { @@ -2402,6 +2568,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param traversal the traversal to apply * @param comparator the comparator to apply typically for some {@link #order()} * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default <V> GraphTraversal<S, E> by(final Traversal<?, ?> traversal, final Comparator<V> comparator) { @@ -2416,6 +2583,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param comparator the comparator to apply typically for some {@link #order()} * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default GraphTraversal<S, E> by(final Comparator<E> comparator) { @@ -2430,6 +2598,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param order the comparator to apply typically for some {@link #order()} * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default GraphTraversal<S, E> by(final Order order) { @@ -2445,6 +2614,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param key the key to apply traversal * @param comparator the comparator to apply typically for some {@link #order()} * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default <V> GraphTraversal<S, E> by(final String key, final Comparator<V> comparator) { @@ -2460,6 +2630,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param function the function to apply * @param comparator the comparator to apply typically for some {@link #order()} * @return the traversal with a modulated step. + * @since 3.0.0-incubating * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#by-step"; target="_blank">Reference Documentation - By Step</a> */ public default <U> GraphTraversal<S, E> by(final Function<U, Object> function, final Comparator comparator) { @@ -2476,6 +2647,8 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param pickToken the token that would trigger this option * @param traversalOption the option as a traversal * @return the traversal with the modulated step + * @since 3.0.0-incubating + * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#choose-step"; target="_blank">Reference Documentation - Choose Step</a> */ public default <M, E2> GraphTraversal<S, E> option(final M pickToken, final Traversal<E, E2> traversalOption) { this.asAdmin().get
<TRUNCATED>
