[05/12] incubator-tinkerpop git commit: Add more javadoc around refactored Io.

[sp...@apache.org]

Add more javadoc around refactored Io.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/478a44d6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/478a44d6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/478a44d6

Branch: refs/heads/master
Commit: 478a44d6f0d20c26bb932108c58862daf9bbaa57
Parents: 69d7761
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Thu Apr 16 12:55:44 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Thu Apr 16 12:55:44 2015 -0400

----------------------------------------------------------------------
 .../apache/tinkerpop/gremlin/structure/io/Mapper.java    | 11 +++++++++++
 1 file changed, 11 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/478a44d6/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Mapper.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Mapper.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Mapper.java
index 1e11028..16f7a9a 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Mapper.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/io/Mapper.java
@@ -18,6 +18,8 @@
  */
 package org.apache.tinkerpop.gremlin.structure.io;
 
+import org.apache.tinkerpop.gremlin.structure.Graph;
+
 /**
  * Represents a low-level serialization class that can be used to map classes to serializers.  These implementation
  * create instances of serializers from other libraries (e.g. creating a {@code Kryo} instance).
@@ -30,7 +32,16 @@ public interface Mapper<T> {
      */
     public T createMapper();
 
+    /**
+     * Largely a marker interface for builders that construct {@link Mapper} instances.
+     */
     public interface Builder<B extends Builder> {
+
+        /**
+         * Adds a vendor supplied {@link IoRegistry} to the {@code Mapper.Builder} which enables it to check for
+         * vendor custom serializers to add to the {@link Mapper}.  All {@link Io} implementations should expose
+         * this method via this {@link Builder} so that it is compatible with {@link Graph#io}.
+         */
         public B addRegistry(final IoRegistry registry);
     }
 }