TINKERPOP-1301 Provide Javadoc for ScriptInput/OutputFormat's ported to tp31 branch
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/d5d2c48e Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/d5d2c48e Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/d5d2c48e Branch: refs/heads/TINKERPOP-1278 Commit: d5d2c48ef67e31671cb177d30c6a15c84b585d24 Parents: 1275437 Author: Lewis John McGibbney <lewis.mcgibb...@gmail.com> Authored: Fri Jun 3 09:00:08 2016 -0700 Committer: Lewis John McGibbney <lewis.mcgibb...@gmail.com> Committed: Fri Jun 3 09:00:08 2016 -0700 ---------------------------------------------------------------------- .../gremlin/hadoop/structure/io/script/ScriptInputFormat.java | 5 +++++ .../gremlin/hadoop/structure/io/script/ScriptOutputFormat.java | 6 ++++++ 2 files changed, 11 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d5d2c48e/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptInputFormat.java ---------------------------------------------------------------------- diff --git a/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptInputFormat.java b/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptInputFormat.java index f6d6c4c..b7c6876 100644 --- a/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptInputFormat.java +++ b/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptInputFormat.java @@ -32,6 +32,11 @@ import org.apache.tinkerpop.gremlin.hadoop.structure.io.VertexWritable; import java.io.IOException; /** + * ScriptInputFormat and {@link org.apache.tinkerpop.gremlin.hadoop.structure.io.script.ScriptOutputFormat} + * take an arbitrary script and use that script to either read or write Vertex objects, + * respectively. This can be considered the most general InputFormat/OutputFormat + * possible in that Hadoop-Gremlin uses the user provided script for all reading/writing. + * @see <a href="http://tinkerpop.apache.org/docs/current/reference/#script-io-format";>Script I/O Format Reference Documentation</a> * @author Marko A. Rodriguez (http://markorodriguez.com) * @author Daniel Kuppitz (http://gremlin.guru) */ http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d5d2c48e/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptOutputFormat.java ---------------------------------------------------------------------- diff --git a/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptOutputFormat.java b/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptOutputFormat.java index b57e43e..85dc106 100644 --- a/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptOutputFormat.java +++ b/hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptOutputFormat.java @@ -29,6 +29,12 @@ import java.io.DataOutputStream; import java.io.IOException; /** + * {@link org.apache.tinkerpop.gremlin.hadoop.structure.io.script.ScriptInputFormat} + * and ScriptOutputFormat take an arbitrary script and use that script to either + * read or write Vertex objects, respectively. This can be considered the most + * general InputFormat/OutputFormat possible in that Hadoop-Gremlin uses the user + * provided script for all reading/writing. + * @see <a href="http://tinkerpop.apache.org/docs/current/reference/#script-io-format";>Script I/O Format Reference Documentation</a> * @author Daniel Kuppitz (http://gremlin.guru) */ public final class ScriptOutputFormat extends CommonFileOutputFormat implements HadoopPoolsConfigurable {
