You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@avro.apache.org by dk...@apache.org on 2020/05/21 15:09:04 UTC

[avro] branch master updated (acce806 -> a57f753)

This is an automated email from the ASF dual-hosted git repository.

dkulp pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/avro.git.


    from acce806  AVRO-2419:Avro-tools should support fieldvisibility settings like avro-maven-plugin AVRO-2419:pom.xml exclude FieldVisibilityTest.java Update SpecificCompilerTool.java Import Locale package Closes #678
     new 331587a  AVRO-2573:Javadoc Warning in java compilation
     new a57f753  Change modification plan

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../java/org/apache/avro/message/BinaryMessageEncoder.java    |  9 +++++----
 .../main/java/org/apache/avro/message/RawMessageEncoder.java  |  9 +++++----
 lang/java/avro/src/main/java/org/apache/avro/package.html     |  4 ++--
 .../avro/src/main/java/org/apache/avro/reflect/MapEntry.java  |  8 ++++----
 .../avro/src/main/java/org/apache/avro/specific/package.html  |  2 +-
 .../java/org/apache/avro/compiler/schema/SchemaVisitor.java   | 11 ++++-------
 .../main/java/org/apache/avro/hadoop/io/AvroSequenceFile.java |  8 ++++----
 .../main/java/org/apache/avro/mapred/tether/TetherJob.java    |  6 +++---
 8 files changed, 28 insertions(+), 29 deletions(-)


[avro] 02/02: Change modification plan

Posted by dk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

dkulp pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/avro.git

commit a57f7537594dd10c85d3ecdeab1d193436e6a978
Author: zeshuai007 <51...@qq.com>
AuthorDate: Wed Nov 6 16:17:08 2019 +0800

    Change modification plan
---
 lang/java/avro/src/main/java/org/apache/avro/package.html             | 4 ++--
 lang/java/avro/src/main/java/org/apache/avro/specific/package.html    | 2 +-
 .../src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java  | 3 ---
 .../mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java | 2 +-
 4 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/lang/java/avro/src/main/java/org/apache/avro/package.html b/lang/java/avro/src/main/java/org/apache/avro/package.html
index c55d265..333627d 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/package.html
+++ b/lang/java/avro/src/main/java/org/apache/avro/package.html
@@ -26,8 +26,8 @@
   org.apache.avro.io.DatumReader} and {@link
   org.apache.avro.io.DatumWriter} implementations.  Generic
   implementations are provided in the {@link org.apache.avro.generic}
-  package.  A {@link <a href="javascript:">org.apache.avro.compiler.specific.SpecificCompiler
-    compiler</a>} can generate specific java classes and interfaces for
+  package.  A {@link <a href="../../../org/apache/avro/compiler/specific/SpecificCompiler.html" title="class in org.apache.avro.compiler.specific">
+    <code>compiler</code></a>} can generate specific java classes and interfaces for
   schemas and protocols.  Schemas may be automatically generated for
   existing Java classes by reflection using the {@link
   org.apache.avro.reflect} package.
diff --git a/lang/java/avro/src/main/java/org/apache/avro/specific/package.html b/lang/java/avro/src/main/java/org/apache/avro/specific/package.html
index 9365633..3915ffd 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/specific/package.html
+++ b/lang/java/avro/src/main/java/org/apache/avro/specific/package.html
@@ -35,7 +35,7 @@ Generate specific Java classes for schemas and protocols.
   the value will be mapped to the object returned by that Conversion. The
   logical type conversions for {@code date}, {@code time-millis}, {@code
   timestamp-millis} and {@code decimal} are pre-defined in the class {@link
-  <a href="javascript:">org.apache.avro.compiler.specific.SpecificCompiler SpecificCompiler</a>}.</li>
+  <a href="../../../../org/apache/avro/compiler/specific/SpecificCompiler.html" title="class in org.apache.avro.compiler.specific"><code>SpecificCompiler</code></a>}.</li>
 
 <li>All other types are mapped as in the {@link org.apache.avro.generic
   generic} API.</li>
diff --git a/lang/java/compiler/src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java b/lang/java/compiler/src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java
index 85d7101..f5d9264 100644
--- a/lang/java/compiler/src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java
+++ b/lang/java/compiler/src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java
@@ -27,7 +27,6 @@ public interface SchemaVisitor<T> {
    * as a terminal. (to avoid circular recursion)
    *
    * @param terminal
-   * @return SchemaVisitorAction
    */
   SchemaVisitorAction visitTerminal(Schema terminal);
 
@@ -35,7 +34,6 @@ public interface SchemaVisitor<T> {
    * Invoked for schema with children before proceeding to visit the children.
    *
    * @param nonTerminal
-   * @return SchemaVisitorAction
    */
   SchemaVisitorAction visitNonTerminal(Schema nonTerminal);
 
@@ -43,7 +41,6 @@ public interface SchemaVisitor<T> {
    * Invoked for schemas with children after its children have been visited.
    *
    * @param nonTerminal
-   * @return SchemaVisitorAction
    */
   SchemaVisitorAction afterVisitNonTerminal(Schema nonTerminal);
 
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java b/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
index 95e3276..b5ce0a3 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
@@ -89,7 +89,7 @@ public class TetherJob extends Configured {
    * enumeration to represent the protocol to use for the communication
    *
    * @param job
-   * @return TetheredProcess.Protocol
+   * @return - Get the currently used protocol
    */
   public static TetheredProcess.Protocol getProtocol(JobConf job) {
 


[avro] 01/02: AVRO-2573:Javadoc Warning in java compilation

Posted by dk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

dkulp pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/avro.git

commit 331587a27f93880a910985ea6a42125d3878bb16
Author: zeshuai007 <51...@qq.com>
AuthorDate: Fri Sep 27 14:49:10 2019 +0800

    AVRO-2573:Javadoc Warning in java compilation
---
 .../java/org/apache/avro/message/BinaryMessageEncoder.java |  9 +++++----
 .../java/org/apache/avro/message/RawMessageEncoder.java    |  9 +++++----
 lang/java/avro/src/main/java/org/apache/avro/package.html  |  4 ++--
 .../src/main/java/org/apache/avro/reflect/MapEntry.java    |  8 ++++----
 .../src/main/java/org/apache/avro/specific/package.html    |  2 +-
 .../org/apache/avro/compiler/schema/SchemaVisitor.java     | 14 +++++++-------
 .../java/org/apache/avro/hadoop/io/AvroSequenceFile.java   |  8 ++++----
 .../main/java/org/apache/avro/mapred/tether/TetherJob.java |  6 +++---
 8 files changed, 31 insertions(+), 29 deletions(-)

diff --git a/lang/java/avro/src/main/java/org/apache/avro/message/BinaryMessageEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/message/BinaryMessageEncoder.java
index 8826cf5..e46ed46 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/message/BinaryMessageEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/message/BinaryMessageEncoder.java
@@ -45,8 +45,8 @@ public class BinaryMessageEncoder<D> implements MessageEncoder<D> {
    * {@link GenericData data model} to deconstruct datum instances described by
    * the {@link Schema schema}.
    * <p>
-   * Buffers returned by {@link #encode(D)} are copied and will not be modified by
-   * future calls to {@code encode}.
+   * Buffers returned by {@link BinaryMessageEncoder#encode} are copied and will
+   * not be modified by future calls to {@code encode}.
    *
    * @param model  the {@link GenericData data model} for datum instances
    * @param schema the {@link Schema} for datum instances
@@ -60,8 +60,9 @@ public class BinaryMessageEncoder<D> implements MessageEncoder<D> {
    * {@link GenericData data model} to deconstruct datum instances described by
    * the {@link Schema schema}.
    * <p>
-   * If {@code shouldCopy} is true, then buffers returned by {@link #encode(D)}
-   * are copied and will not be modified by future calls to {@code encode}.
+   * If {@code shouldCopy} is true, then buffers returned by
+   * {@link BinaryMessageEncoder#encode} are copied and will not be modified by
+   * future calls to {@code encode}.
    * <p>
    * If {@code shouldCopy} is false, then buffers returned by {@code encode} wrap
    * a thread-local buffer that can be reused by future calls to {@code encode},
diff --git a/lang/java/avro/src/main/java/org/apache/avro/message/RawMessageEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/message/RawMessageEncoder.java
index 1e0d041..093783e 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/message/RawMessageEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/message/RawMessageEncoder.java
@@ -49,8 +49,8 @@ public class RawMessageEncoder<D> implements MessageEncoder<D> {
    * {@link GenericData data model} to deconstruct datum instances described by
    * the {@link Schema schema}.
    * <p>
-   * Buffers returned by {@link #encode(D)} are copied and will not be modified by
-   * future calls to {@code encode}.
+   * Buffers returned by {@link RawMessageEncoder#encode} are copied and will not
+   * be modified by future calls to {@code encode}.
    *
    * @param model  the {@link GenericData data model} for datum instances
    * @param schema the {@link Schema} for datum instances
@@ -64,8 +64,9 @@ public class RawMessageEncoder<D> implements MessageEncoder<D> {
    * {@link GenericData data model} to deconstruct datum instances described by
    * the {@link Schema schema}.
    * <p>
-   * If {@code shouldCopy} is true, then buffers returned by {@link #encode(D)}
-   * are copied and will not be modified by future calls to {@code encode}.
+   * If {@code shouldCopy} is true, then buffers returned by
+   * {@link RawMessageEncoder#encode} are copied and will not be modified by
+   * future calls to {@code encode}.
    * <p>
    * If {@code shouldCopy} is false, then buffers returned by {@code encode} wrap
    * a thread-local buffer that can be reused by future calls to {@code encode},
diff --git a/lang/java/avro/src/main/java/org/apache/avro/package.html b/lang/java/avro/src/main/java/org/apache/avro/package.html
index 0095732..c55d265 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/package.html
+++ b/lang/java/avro/src/main/java/org/apache/avro/package.html
@@ -26,8 +26,8 @@
   org.apache.avro.io.DatumReader} and {@link
   org.apache.avro.io.DatumWriter} implementations.  Generic
   implementations are provided in the {@link org.apache.avro.generic}
-  package.  A {@link org.apache.avro.compiler.specific.SpecificCompiler
-  compiler} can generate specific java classes and interfaces for
+  package.  A {@link <a href="javascript:">org.apache.avro.compiler.specific.SpecificCompiler
+    compiler</a>} can generate specific java classes and interfaces for
   schemas and protocols.  Schemas may be automatically generated for
   existing Java classes by reflection using the {@link
   org.apache.avro.reflect} package.
diff --git a/lang/java/avro/src/main/java/org/apache/avro/reflect/MapEntry.java b/lang/java/avro/src/main/java/org/apache/avro/reflect/MapEntry.java
index 07993fb..fcae137 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/reflect/MapEntry.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/reflect/MapEntry.java
@@ -21,10 +21,10 @@ import java.util.Map;
 
 /**
  * Class to make Avro immune from the naming variations of key/value fields
- * among several {@link Map.Entry} implementations. If objects of this class are
- * used instead of the regular ones obtained by {@link Map#entrySet()}, then we
- * need not worry about the actual field-names or any changes to them in the
- * future.<BR>
+ * among several {@link java.util.Map.Entry} implementations. If objects of this
+ * class are used instead of the regular ones obtained by
+ * {@link Map#entrySet()}, then we need not worry about the actual field-names
+ * or any changes to them in the future.<BR>
  * Example: {@code ConcurrentHashMap.MapEntry} does not name the fields as key/
  * value in Java 1.8 while it used to do so in Java 1.7
  *
diff --git a/lang/java/avro/src/main/java/org/apache/avro/specific/package.html b/lang/java/avro/src/main/java/org/apache/avro/specific/package.html
index 64f1b57..9365633 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/specific/package.html
+++ b/lang/java/avro/src/main/java/org/apache/avro/specific/package.html
@@ -35,7 +35,7 @@ Generate specific Java classes for schemas and protocols.
   the value will be mapped to the object returned by that Conversion. The
   logical type conversions for {@code date}, {@code time-millis}, {@code
   timestamp-millis} and {@code decimal} are pre-defined in the class {@link
-  org.apache.avro.compiler.specific.SpecificCompiler SpecificCompiler}.</li>
+  <a href="javascript:">org.apache.avro.compiler.specific.SpecificCompiler SpecificCompiler</a>}.</li>
 
 <li>All other types are mapped as in the {@link org.apache.avro.generic
   generic} API.</li>
diff --git a/lang/java/compiler/src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java b/lang/java/compiler/src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java
index 1711a07..85d7101 100644
--- a/lang/java/compiler/src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java
+++ b/lang/java/compiler/src/main/java/org/apache/avro/compiler/schema/SchemaVisitor.java
@@ -25,31 +25,31 @@ public interface SchemaVisitor<T> {
    * Invoked for schemas that do not have "child" schemas (like string, int ...)
    * or for a previously encountered schema with children, which will be treated
    * as a terminal. (to avoid circular recursion)
-   * 
+   *
    * @param terminal
-   * @return
+   * @return SchemaVisitorAction
    */
   SchemaVisitorAction visitTerminal(Schema terminal);
 
   /**
    * Invoked for schema with children before proceeding to visit the children.
-   * 
+   *
    * @param nonTerminal
-   * @return
+   * @return SchemaVisitorAction
    */
   SchemaVisitorAction visitNonTerminal(Schema nonTerminal);
 
   /**
    * Invoked for schemas with children after its children have been visited.
-   * 
+   *
    * @param nonTerminal
-   * @return
+   * @return SchemaVisitorAction
    */
   SchemaVisitorAction afterVisitNonTerminal(Schema nonTerminal);
 
   /**
    * Invoked when visiting is complete.
-   * 
+   *
    * @return a value which will be returned by the visit method.
    */
   T get();
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSequenceFile.java b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSequenceFile.java
index f513b13..93c3f91 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSequenceFile.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSequenceFile.java
@@ -57,10 +57,10 @@ import static org.apache.hadoop.fs.CommonConfigurationKeysPublic.IO_FILE_BUFFER_
  * <p>
  * Since Avro data are Plain Old Java Objects (e.g., <code>Integer</code> for
  * data with schema <i>"int"</i>), they do not implement <i>Writable</i>.
- * Furthermore, a {@link org.apache.hadoop.io.Serialization} implementation
- * cannot determine whether an object instance of type <code>CharSequence</code>
- * that also implements <code>Writable</code> should be serialized using Avro or
- * WritableSerialization.
+ * Furthermore, a {@link org.apache.hadoop.io.serializer.Serialization}
+ * implementation cannot determine whether an object instance of type
+ * <code>CharSequence</code> that also implements <code>Writable</code> should
+ * be serialized using Avro or WritableSerialization.
  * </p>
  *
  * <p>
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java b/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
index 8798d80..95e3276 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapred/tether/TetherJob.java
@@ -62,7 +62,7 @@ public class TetherJob extends Configured {
   /**
    * Set the URI for the application's executable (i.e the program to run in a
    * subprocess and provides the mapper/reducer).
-   * 
+   *
    * @param job        - Job
    * @param executable - The URI of the executable
    * @param args       - List of additional arguments; Null if no arguments
@@ -87,9 +87,9 @@ public class TetherJob extends Configured {
   /**
    * Extract from the job configuration file an instance of the TRANSPROTO
    * enumeration to represent the protocol to use for the communication
-   * 
+   *
    * @param job
-   * @return
+   * @return TetheredProcess.Protocol
    */
   public static TetheredProcess.Protocol getProtocol(JobConf job) {