You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2016/01/12 21:39:25 UTC
incubator-tinkerpop git commit: Fixed Io.Builder related javadoc
warnings.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/master 9cf6b485a -> 778e5bf7b
Fixed Io.Builder related javadoc warnings.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/778e5bf7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/778e5bf7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/778e5bf7
Branch: refs/heads/master
Commit: 778e5bf7be0e04c542b154ebd7f90d8dfdb2ccd3
Parents: 9cf6b48
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Tue Jan 12 15:39:07 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Tue Jan 12 15:39:07 2016 -0500
----------------------------------------------------------------------
.../apache/tinkerpop/gremlin/structure/Graph.java | 15 ++++++++-------
.../apache/tinkerpop/gremlin/structure/io/Io.java | 8 ++++----
2 files changed, 12 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/778e5bf7/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
index 1684cac..f4f2511 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
@@ -282,14 +282,15 @@ public interface Graph extends AutoCloseable, Host {
/**
* Construct a particular {@link Io} implementation for reading and writing the {@code Graph} and other data.
- * End-users will "select" the {@link Io} implementation that they want to use by supplying the {@link Io.Builder}
- * that constructs it. In this way, {@code Graph} vendors can supply their {@link IoRegistry} to that builder
- * thus allowing for custom serializers to be auto-configured into the {@link Io} instance. Registering custom
- * serializers is particularly useful for those graphs that have complex types for {@link Element} identifiers.
- * </br>
+ * End-users will "select" the {@link Io} implementation that they want to use by supplying the
+ * {@link org.apache.tinkerpop.gremlin.structure.io.Io.Builder} that constructs it. In this way, {@code Graph}
+ * vendors can supply their {@link IoRegistry} to that builder thus allowing for custom serializers to be
+ * auto-configured into the {@link Io} instance. Registering custom serializers is particularly useful for those
+ * graphs that have complex types for {@link Element} identifiers.
+ * </p>
* For those graphs that do not need to register any custom serializers, the default implementation should suffice.
- * If the default is overriden, take care to register the current graph to the {@link Io.Builder} via the
- * {@link Io.Builder#graph(Graph)} method.
+ * If the default is overridden, take care to register the current graph via the
+ * {@link org.apache.tinkerpop.gremlin.structure.io.Io.Builder#graph(Graph)} method.
*/
public default <I extends Io> I io(final Io.Builder<I> builder) {
return (I) builder.graph(this).create();
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/778e5bf7/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Io.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Io.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Io.java
index 47085e0..d94cebd 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Io.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Io.java
@@ -24,7 +24,7 @@ import java.io.IOException;
/**
* Ties together the core interfaces of an IO format: {@link GraphReader}, {@link GraphWriter} and {@link Mapper}.
- * The {@link Builder} of an {@code Io} instance is supplied to {@link Graph#io(Builder)} and the {@link Graph}
+ * The {@link Builder} of an {@code Io} instance is supplied to {@link Graph#io(Io.Builder)} and the {@link Graph}
* implementation can then chose to supply an {@link IoRegistry} to it before returning it. An {@link Io}
* implementation should use that {@link IoRegistry} to lookup custom serializers to use and register them to the
* internal {@link Mapper} (if the format has such capability).
@@ -81,7 +81,7 @@ public interface Io<R extends GraphReader.ReaderBuilder, W extends GraphWriter.W
/**
* Helps to construct an {@link Io} implementation and should be implemented by every such implementation as
- * that class will be passed to {@link Graph#io(Builder)} by the user.
+ * that class will be passed to {@link Graph#io(Io.Builder)} by the user.
*/
public interface Builder<I extends Io> {
@@ -89,7 +89,7 @@ public interface Io<R extends GraphReader.ReaderBuilder, W extends GraphWriter.W
* Vendors use this method to supply an {@link IoRegistry} to the {@link Io} implementation. End-users
* should not use this method directly. If a user wants to register custom serializers, then such things
* can be done via calls to {@link Io#mapper()} after the {@link Io} is constructed via
- * {@link Graph#io(Builder)}.
+ * {@link Graph#io(Io.Builder)}.
*/
public Builder<? extends Io> registry(final IoRegistry registry);
@@ -100,7 +100,7 @@ public interface Io<R extends GraphReader.ReaderBuilder, W extends GraphWriter.W
public Builder<? extends Io> graph(final Graph g);
/**
- * Vendors call this method in the {@link Graph#io(Builder)} method to construct the {@link Io} instance
+ * Vendors call this method in the {@link Graph#io(Io.Builder)} method to construct the {@link Io} instance
* and return the value. End-users will typically not call this method.
*/
public I create();