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 2019/07/11 16:08:55 UTC
[tinkerpop] branch master updated: Removed some internal
deprecation.
This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new f390a5d Removed some internal deprecation.
f390a5d is described below
commit f390a5d1f507dbc24a9e755c796bdbf83d2b428c
Author: Stephen Mallette <sp...@genoprime.com>
AuthorDate: Thu Jul 11 12:00:56 2019 -0400
Removed some internal deprecation.
Nothing too groundbreaking here. A few miscellaneous aside from AbstractOpProcessor which might affect some providers. It's a light correction to make in their code. CTR
---
CHANGELOG.asciidoc | 3 +++
docs/src/upgrade/release-3.5.x.asciidoc | 12 ++++++++++++
.../traversal/dsl/graph/GraphTraversal.java | 7 ++++---
.../traversal/step/map/PropertyMapStep.java | 22 +++++-----------------
.../gremlin/structure/util/star/StarGraph.java | 22 +---------------------
.../gremlin/server/op/AbstractOpProcessor.java | 15 +--------------
.../server/op/traversal/TraversalOpProcessor.java | 7 ++++---
7 files changed, 30 insertions(+), 58 deletions(-)
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index 47702b1..68f4a5d 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -32,6 +32,9 @@ This release also includes changes from <<release-3-4-3, 3.4.3>>.
* Removed previously deprecated `TraversalSource.withRemote()`.
* Removed previously deprecated `VertexProgram` related infrastructure.
* Removed previously deprecated SSL settings: `keyCertChainFile`, `keyFile`, `keyPassword` and `trustCertChainFile` and related infrastructure.
+* Removed previously deprecated `PropertyMapStep` constructor and `isIncludeTokens`.
+* Removed previously dperecated `StarGraph.builder()` and `StarGraph.Builder.create()`.
+* Removed previously deprecated `AbstractOpProcessor.generateMetaData(ChannelHandlerContext, RequestMessage, ResponseStatusCode, Iterator)`
* Removed previously deprecated `BulkDumperVertexProgram` and `BulkLoaderVertexProgram`.
* Upgrade to Neo4j 3.4.11
diff --git a/docs/src/upgrade/release-3.5.x.asciidoc b/docs/src/upgrade/release-3.5.x.asciidoc
index 420f5b4..be2e271 100644
--- a/docs/src/upgrade/release-3.5.x.asciidoc
+++ b/docs/src/upgrade/release-3.5.x.asciidoc
@@ -109,6 +109,10 @@ The following deprecated classes, methods or fields have been removed in this ve
** `org.apache.tinkerpop.gremlin.process.computer.traversal.step.map.PeerPressureVertexProgramStep.modulateTimes()`
** `org.apache.tinkerpop.gremlin.process.traversal.TraversalSource#withRemote(*)`
** `org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource#withRemote(*)`
+** `org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep(Traversal.Admin, boolean, PropertyType, String...)`
+** `org.apache.tinkerpop.gremlin.process.traversal.step.map.PropertyMapStep#isIncludeTokens()`
+** `org.apache.tinkerpop.gremlin.structure.util.star.StarGraph#builder()`
+** `org.apache.tinkerpop.gremlin.structure.util.star.StarGraph.Builder.create()`
* `gremlin-driver`
** `org.apache.tinkerpop.gremlin.driver.Cluster.Builder#keyCertChainFile(String)`
** `org.apache.tinkerpop.gremlin.driver.Cluster.Builder#keyFile(String)`
@@ -119,6 +123,7 @@ The following deprecated classes, methods or fields have been removed in this ve
** `org.apache.tinkerpop.gremlin.server.Settings.SslSettings.keyFile`
** `org.apache.tinkerpop.gremlin.server.Settings.SslSettings.keyPassword`
** `org.apache.tinkerpop.gremlin.server.Settings.SslSettings.trustCertificateChainFile`
+** `org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor.generateMetaData(ChannelHandlerContext, RequestMessage, ResponseStatusCode, Iterator)`
See: link:https://issues.apache.org/jira/browse/TINKERPOP-2080[TINKERPOP-2080],
link:https://issues.apache.org/jira/browse/TINKERPOP-2231[TINKERPOP-2231],
@@ -129,6 +134,13 @@ link:http://tinkerpop.apache.org/docs/3.5.0/upgrade/#_ssl_security[3.2.10 Upgrad
==== Graph System Providers
+===== AbstractOpProcessor API Change
+
+The `generateMetaData()` method was removed as it was deprecated in a previous version. There already was a preferred
+method called `generateResultMetaData()` that took an extra `Settings` parameter. To fix compilation issues simply
+replace implementations of the `generateMetaData()` method with `generateResultMetaData()`. Gremlin Server has
+only been calling `generateResultMetaData()` since the deprecation, so this correction should be straightforward.
+
===== StoreStep and AggregateStep
Note that `StoreStep` has been renamed to `AggregateLocalStep` and `AggregateStep` has been renamed to
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 6f12350..3dfb392 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
@@ -140,6 +140,7 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.TraversalS
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.TreeSideEffectStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.util.HasContainer;
import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree;
+import org.apache.tinkerpop.gremlin.process.traversal.step.util.WithOptions;
import org.apache.tinkerpop.gremlin.process.traversal.traverser.util.TraverserSet;
import org.apache.tinkerpop.gremlin.process.traversal.util.TraversalHelper;
import org.apache.tinkerpop.gremlin.process.traversal.util.TraversalMetrics;
@@ -548,7 +549,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
*/
public default <E2> GraphTraversal<S, Map<String, E2>> propertyMap(final String... propertyKeys) {
this.asAdmin().getBytecode().addStep(Symbols.propertyMap, propertyKeys);
- return this.asAdmin().addStep(new PropertyMapStep<>(this.asAdmin(), false, PropertyType.PROPERTY, propertyKeys));
+ return this.asAdmin().addStep(new PropertyMapStep<>(this.asAdmin(), WithOptions.none, PropertyType.PROPERTY, propertyKeys));
}
/**
@@ -563,7 +564,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
*/
public default <E2> GraphTraversal<S, Map<Object, E2>> valueMap(final String... propertyKeys) {
this.asAdmin().getBytecode().addStep(Symbols.valueMap, propertyKeys);
- return this.asAdmin().addStep(new PropertyMapStep<>(this.asAdmin(), false, PropertyType.VALUE, propertyKeys));
+ return this.asAdmin().addStep(new PropertyMapStep<>(this.asAdmin(), WithOptions.none, PropertyType.VALUE, propertyKeys));
}
/**
@@ -582,7 +583,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
@Deprecated
public default <E2> GraphTraversal<S, Map<Object, E2>> valueMap(final boolean includeTokens, final String... propertyKeys) {
this.asAdmin().getBytecode().addStep(Symbols.valueMap, includeTokens, propertyKeys);
- return this.asAdmin().addStep(new PropertyMapStep<>(this.asAdmin(), includeTokens, PropertyType.VALUE, propertyKeys));
+ return this.asAdmin().addStep(new PropertyMapStep<>(this.asAdmin(), WithOptions.all, PropertyType.VALUE, propertyKeys));
}
/**
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/PropertyMapStep.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/PropertyMapStep.java
index 98a284b..a58aaaf 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/PropertyMapStep.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/map/PropertyMapStep.java
@@ -61,15 +61,6 @@ public class PropertyMapStep<K,E> extends MapStep<Element, Map<K, E>>
private Parameters parameters = new Parameters();
private TraversalRing<K, E> traversalRing;
- /**
- * @deprecated As of release 3.4.0, replaced by {@link #PropertyMapStep(Traversal.Admin, PropertyType, String...)}.
- */
- @Deprecated
- public PropertyMapStep(final Traversal.Admin traversal, final boolean includeTokens, final PropertyType propertyType, final String... propertyKeys) {
- this(traversal, propertyType, propertyKeys);
- this.configure(WithOptions.tokens, includeTokens ? WithOptions.all : WithOptions.none);
- }
-
public PropertyMapStep(final Traversal.Admin traversal, final PropertyType propertyType, final String... propertyKeys) {
super(traversal);
this.propertyKeys = propertyKeys;
@@ -78,6 +69,11 @@ public class PropertyMapStep<K,E> extends MapStep<Element, Map<K, E>>
this.traversalRing = new TraversalRing<>();
}
+ public PropertyMapStep(final Traversal.Admin traversal, final int options, final PropertyType propertyType, final String... propertyKeys) {
+ this(traversal, propertyType, propertyKeys);
+ this.configure(WithOptions.tokens, options);
+ }
+
@Override
protected Map<K, E> map(final Traverser.Admin<Element> traverser) {
final Map<Object, Object> map = new LinkedHashMap<>();
@@ -167,14 +163,6 @@ public class PropertyMapStep<K,E> extends MapStep<Element, Map<K, E>>
return propertyKeys;
}
- /**
- * @deprecated As of release 3.4.0, replaced by {@link #getIncludedTokens()}.
- */
- @Deprecated
- public boolean isIncludeTokens() {
- return this.tokens != WithOptions.none;
- }
-
public String toString() {
return StringFactory.stepString(this, Arrays.asList(this.propertyKeys),
this.traversalRing, this.returnType.name().toLowerCase());
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/star/StarGraph.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/star/StarGraph.java
index aed47c4..3bcdb7d 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/star/StarGraph.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/star/StarGraph.java
@@ -224,14 +224,6 @@ public final class StarGraph implements Graph, Serializable {
return starGraph;
}
- /**
- * @deprecated As of release 3.3.5, replaced by {@link #build()}.
- */
- @Deprecated
- public static StarGraph.Builder builder() {
- return build();
- }
-
public static StarGraph.Builder build() {
return new Builder();
}
@@ -244,7 +236,7 @@ public final class StarGraph implements Graph, Serializable {
private boolean compareIdsUsingStrings = true;
/**
- * Call {@link #builder()} to instantiate
+ * Call {@link #build()} to instantiate
*/
private Builder() { }
@@ -270,9 +262,6 @@ public final class StarGraph implements Graph, Serializable {
* However, if this builder method is never invoked, then the builder is guaranteed to use
* whatever default value StarGraph's other public constructors or factory methods would use.
* This option exists solely for performance tuning in specialized use-cases.
- *
- * @param b
- * @return
*/
public Builder compareIdsUsingStrings(final boolean b) {
this.compareIdsUsingStrings = b;
@@ -281,15 +270,6 @@ public final class StarGraph implements Graph, Serializable {
/**
* @return a new StarGraph
- * @deprecated As of release 3.3.5, replaced by {@link #create()}.
- */
- @Deprecated
- public StarGraph build() {
- return create();
- }
-
- /**
- * @return a new StarGraph
*/
public StarGraph create() {
return new StarGraph(internStrings, compareIdsUsingStrings);
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/AbstractOpProcessor.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/AbstractOpProcessor.java
index 2cc0f57..e3cef3d 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/AbstractOpProcessor.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/AbstractOpProcessor.java
@@ -238,24 +238,11 @@ public abstract class AbstractOpProcessor implements OpProcessor {
*
* @param itty a reference to the current {@link Iterator} of results - it is not meant to be forwarded in
* this method
- * @deprecated As of release 3.4.0, replaced by {@link #generateResultMetaData(ChannelHandlerContext, RequestMessage, ResponseStatusCode, Iterator, Settings)}
- */
- @Deprecated
- protected Map<String, Object> generateMetaData(final ChannelHandlerContext ctx, final RequestMessage msg,
- final ResponseStatusCode code, final Iterator itty) {
- return Collections.emptyMap();
- }
-
- /**
- * Generates response result meta-data to put on a {@link ResponseMessage}.
- *
- * @param itty a reference to the current {@link Iterator} of results - it is not meant to be forwarded in
- * this method
*/
protected Map<String, Object> generateResultMetaData(final ChannelHandlerContext ctx, final RequestMessage msg,
final ResponseStatusCode code, final Iterator itty,
final Settings settings) {
- return generateMetaData(ctx, msg, code, itty);
+ return Collections.emptyMap();
}
/**
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
index 5205cf7..5f7ea0f 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
@@ -449,8 +449,9 @@ public class TraversalOpProcessor extends AbstractOpProcessor {
}
@Override
- protected Map<String, Object> generateMetaData(final ChannelHandlerContext ctx, final RequestMessage msg,
- final ResponseStatusCode code, final Iterator itty) {
+ protected Map<String, Object> generateResultMetaData(final ChannelHandlerContext ctx, final RequestMessage msg,
+ final ResponseStatusCode code, final Iterator itty,
+ final Settings settings) {
// leaving this overriding the deprecated version of this method because it provides a decent test to those
// who might have their own OpProcessor implementations that apply meta-data. leaving this alone helps validate
// that the upgrade path is clean. it can be removed at the next breaking change 3.5.0
@@ -465,7 +466,7 @@ public class TraversalOpProcessor extends AbstractOpProcessor {
}
} else {
// this is a standard traversal iterator
- metaData = super.generateMetaData(ctx, msg, code, itty);
+ metaData = super.generateResultMetaData(ctx, msg, code, itty, settings);
}
return metaData;