Add java docs for Native Compiler
Project: http://git-wip-us.apache.org/repos/asf/gora/repo Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/b1f906c2 Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/b1f906c2 Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/b1f906c2 Branch: refs/heads/master Commit: b1f906c263217909d7c8ba555eb2464ea120ade5 Parents: 266ebf4 Author: madhawa-gunasekara <[email protected]> Authored: Mon Aug 14 00:39:52 2017 +0530 Committer: madhawa-gunasekara <[email protected]> Committed: Mon Aug 14 00:39:52 2017 +0530 ---------------------------------------------------------------------- .../gora/cassandra/compiler/GoraCassandraNativeCompiler.java | 8 ++++++++ 1 file changed, 8 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/gora/blob/b1f906c2/gora-cassandra-cql/src/main/java/org/apache/gora/cassandra/compiler/GoraCassandraNativeCompiler.java ---------------------------------------------------------------------- diff --git a/gora-cassandra-cql/src/main/java/org/apache/gora/cassandra/compiler/GoraCassandraNativeCompiler.java b/gora-cassandra-cql/src/main/java/org/apache/gora/cassandra/compiler/GoraCassandraNativeCompiler.java index 369ff31..fd34a48 100644 --- a/gora-cassandra-cql/src/main/java/org/apache/gora/cassandra/compiler/GoraCassandraNativeCompiler.java +++ b/gora-cassandra-cql/src/main/java/org/apache/gora/cassandra/compiler/GoraCassandraNativeCompiler.java @@ -34,6 +34,14 @@ import java.nio.charset.Charset; import java.util.List; import java.util.Locale; +/** + * This class generate Java classes for Cassandra Native Serialization. + * <p> + * Generate specific Java classes for defined Gora cassandra mapping. + * Different from the @see org.apache.gora.compiler.GoraCompiler, + * which uses an .avsc or .json schema definition, this compiler + * expects an XML mapping file as input. + */ public class GoraCassandraNativeCompiler { private static final Logger log = LoggerFactory.getLogger(GoraCassandraNativeCompiler.class);
