diff --git a/lang/java/avro/src/main/java/org/apache/avro/Conversion.java b/lang/java/avro/src/main/java/org/apache/avro/Conversion.java index 934672e7d30..a257b2f38af 100644 --- a/lang/java/avro/src/main/java/org/apache/avro/Conversion.java +++ b/lang/java/avro/src/main/java/org/apache/avro/Conversion.java @@ -21,9 +21,7 @@ import java.nio.ByteBuffer; import java.util.Collection; import java.util.Map; -import java.util.ServiceLoader; -import org.apache.avro.generic.GenericData; import org.apache.avro.generic.GenericEnumSymbol; import org.apache.avro.generic.GenericFixed; import org.apache.avro.generic.IndexedRecord; @@ -33,11 +31,12 @@ *
* Instances of this class can be added to GenericData to convert a logical type * to a particular representation. This can be done manually, using - * {@link GenericData#addLogicalTypeConversion(Conversion)}, or automatically. - * This last option uses the Java {@link ServiceLoader}, and requires the - * implementation to be a public class with a public no-arg constructor, be - * named in a file called {@code /META-INF/services/org.apache.avro.Conversion}, - * and both must available in the classpath. + * {@link org.apache.avro.generic.GenericData#addLogicalTypeConversion(Conversion)}, + * or automatically. This last option uses the Java + * {@link java.util.ServiceLoader}, and requires the implementation to be a + * public class with a public no-arg constructor, be named in a file called + * {@code /META-INF/services/org.apache.avro.Conversion}, and both must + * available in the classpath. *
* Implementations must provide: *
* The {@link SchemaParser} class uses this interface, supporting text based * schema sources. - *
+ ** *
* Implementations are located using a {@link java.util.ServiceLoader} and must * therefore be threadsafe. See the {@code ServiceLoader} class for details on * loading your implementation. - *
+ ** * @see java.util.ServiceLoader */ @@ -40,7 +40,7 @@ public interface FormattedSchemaParser { /** *
* Parse schema definitions from a text based source. - *
+ ** *
*/ public class JsonSchemaParser implements FormattedSchemaParser { /** *
* Parse a schema written in the internal (JSON) format without any validations. - *
+ ** *
* Using this method is only safe if used to parse a write schema (i.e., a * schema used to read Avro data). Other usages, for example by generated Avro * code, can cause interoperability problems. - *
+ ** *
* Use with care and sufficient testing! - *
+ ** * @param fragments one or more strings making up the schema (some schemata * exceed the compiler limits) diff --git a/lang/java/avro/src/main/java/org/apache/avro/ParseContext.java b/lang/java/avro/src/main/java/org/apache/avro/ParseContext.java index 1d0873eb8b1..dec4f60ac47 100644 --- a/lang/java/avro/src/main/java/org/apache/avro/ParseContext.java +++ b/lang/java/avro/src/main/java/org/apache/avro/ParseContext.java @@ -44,12 +44,12 @@ * *
* This class is NOT thread-safe. - *
+ ** *
* Note: this class has no use for most Avro users, but is a key component when * implementing a schema parser. - *
+ ** * @see JSON based * schema definition @@ -129,11 +129,11 @@ public boolean contains(String name) { /** *
* Find a schema by name and namespace. - *
+ ** *
* That is: - *
+ ** *
* * @param name the schema name to find * @param namespace the namespace to find the schema against @@ -201,7 +201,7 @@ public Schema getNamedSchema(String fullName) { * Note that although this method works for all types except for arrays, maps * and unions, all primitive types have already been defined upon construction. * This means you cannot redefine a 'long' with a logical timestamp type. - *
+ ** * @param schema the schema to put into the context */ diff --git a/lang/java/avro/src/main/java/org/apache/avro/Schema.java b/lang/java/avro/src/main/java/org/apache/avro/Schema.java index 87f9d045db6..fe6d4ce75aa 100644 --- a/lang/java/avro/src/main/java/org/apache/avro/Schema.java +++ b/lang/java/avro/src/main/java/org/apache/avro/Schema.java @@ -400,12 +400,12 @@ public int getFixedSize() { /** *
* Render this as JSON. - *
+ ** *
* This method is equivalent to: * {@code SchemaFormatter.getInstance("json").format(this)} - *
+ **/ @Override public String toString() { diff --git a/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java b/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java index 66fa8fbbd32..b8cc801caf8 100644 --- a/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java +++ b/lang/java/avro/src/main/java/org/apache/avro/SchemaBuilder.java @@ -48,7 +48,7 @@ * is designed to mimic the * Avro Schema * Specification - *
+ ** For example, the below JSON schema and the fluent builder code to create it * are very similar: * @@ -72,13 +72,13 @@ * .name("serverHash").type("MD5").noDefault().name("meta").type().nullable().map().values().bytesType().noDefault() * .endRecord(); * - *
+ ** *
*
*
* Each named type completes configuration of the optional properties with its * own method: *
* Fields have default values that must be specified to complete the field. * {@link FieldDefault#noDefault()} is available for all field types, and a * specific method is available for each type to use a default, for example * {@link IntDefault#intDefault(int)} - *
+ ** There are field shortcut methods on {@link FieldAssembler} for primitive * types. These shortcuts create required, optional, and nullable fields, but do * not support field aliases, doc, or custom properties. @@ -194,7 +194,7 @@ * * In a field context, the first type of a union defines what default type is * allowed. - *
+ ** Unions have two shortcuts for common cases. nullable() creates a union of a * type and null. In a field type context, optional() is available and creates a * union of null and a type, with a null default. The below two are equivalent: @@ -225,7 +225,7 @@ * as a default to child fields, nested types, or later defined types in a * union. To specify a name that has no namespace and ignore the inherited * namespace, set the namespace to "". - *
+ *
* {@link SchemaBuilder#builder(String)} returns a type builder with a default
* namespace. {@link SchemaBuilder#builder()} returns a type builder with no
* default namespace.
@@ -405,7 +405,7 @@ final
* All Avro named types and fields have 'doc', 'aliases', and 'name' components.
* 'name' is required, and provided to this builder. 'doc' and 'aliases' are
* optional.
@@ -479,7 +479,7 @@ protected NamespacedBuilder(Completion
* When the namespace is null or unset, the namespace of the type defaults to
* the namespace of the enclosing context.
**/
@@ -724,11 +724,11 @@ public R endNull() {
/**
* Builds an Avro Fixed type with optional properties, namespace, doc, and
* aliases.
- *
* Set properties with {@link #prop(String, String)}, namespace with
* {@link #namespace(String)}, doc with {@link #doc(String)}, and aliases with
* {@link #aliases(String[])}.
- *
* The Fixed schema is finalized when its required size is set via
* {@link #size(int)}.
**/
@@ -757,11 +757,11 @@ public R size(int size) {
/**
* Builds an Avro Enum type with optional properties, namespace, doc, and
* aliases.
- *
* Set properties with {@link #prop(String, String)}, namespace with
* {@link #namespace(String)}, doc with {@link #doc(String)}, and aliases with
* {@link #aliases(String[])}.
- *
* The Enum schema is finalized when its required symbols are set via
* {@link #symbols(String[])}.
**/
@@ -800,9 +800,9 @@ public EnumBuilder
* Set properties with {@link #prop(String, String)}.
- *
* The Map schema's properties are finalized when {@link #values()} or
* {@link #values(Schema)} is called.
**/
@@ -843,9 +843,9 @@ public R values(Schema valueSchema) {
/**
* Builds an Avro Array type with optional properties.
- *
* Set properties with {@link #prop(String, String)}.
- *
* The Array schema's properties are finalized when {@link #items()} or
* {@link #items(Schema)} is called.
**/
@@ -971,7 +971,7 @@ private String resolveName(String name, String space) {
* A common API for building types within a context. BaseTypeBuilder can build
* all types other than Unions. {@link TypeBuilder} can additionally build
* Unions.
- *
* The builder has two contexts:
*
* The name may be fully qualified or a short name. If it is a short name, the
* default namespace of the current context will additionally be searched.
**/
@@ -1008,7 +1008,7 @@ public final R type(String name) {
/**
* Look up the type by name and namespace. This type must be previously defined
* in the context of this builder.
- *
* The name may be fully qualified or a short name. If it is a fully qualified
* name, the namespace provided is ignored. If it is a short name, the namespace
* provided is used if not null, else the default namespace of the current
@@ -1278,7 +1278,7 @@ protected BaseTypeBuilder
* For example, the code snippets below are equivalent:
*
*
* The methods on this class create builder instances that return their control
* to the {@link FieldAssembler} of the enclosing record context after
* configuring a default for the field.
- *
* For example, an int field with default value 1:
*
*
* For example, the two code snippets below are equivalent:
*
*
* For example, the two code snippets below are equivalent:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* This is equivalent to:
*
*
* The name must correspond with a named schema that has already been created in
* the context of this builder. The name may be a fully qualified name, or a
* short name. If it is a short name, the namespace context of this builder will
* be used.
- *
* The name and namespace context rules are the same as the Avro schema JSON
* specification.
*/
@@ -2232,13 +2232,13 @@ public GenericDefault
* The name must correspond with a named schema that has already been created in
* the context of this builder. The name may be a fully qualified name, or a
* short name. If it is a full name, the namespace is ignored. If it is a short
* name, the namespace provided is used. If the namespace provided is null, the
* namespace context of this builder will be used.
- *
* The name and namespace context rules are the same as the Avro schema JSON
* specification.
*/
diff --git a/lang/java/avro/src/main/java/org/apache/avro/SchemaCompatibility.java b/lang/java/avro/src/main/java/org/apache/avro/SchemaCompatibility.java
index 8b6a2839ad6..77a1257c239 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/SchemaCompatibility.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/SchemaCompatibility.java
@@ -87,7 +87,7 @@ public static SchemaPairCompatibility checkReaderWriterCompatibility(final Schem
*
*
* Matching includes reader name aliases.
- *
*
* @param reader Named reader schema.
* @param writer Named writer schema.
@@ -106,7 +106,7 @@ public static boolean schemaNameEquals(final Schema reader, final Schema writer)
*
*
* Matching includes reader name aliases.
- *
*
* @param writerSchema Schema of the record where to look for the writer field.
* @param readerField Reader field to identify the corresponding writer field
@@ -188,7 +188,7 @@ public String toString() {
*
*
* Provides memoization to handle recursive schemas.
- *
*/
private static final class ReaderWriterCompatibilityChecker {
private static final String ROOT_REFERENCE_TOKEN = "";
@@ -199,7 +199,7 @@ private static final class ReaderWriterCompatibilityChecker {
*
*
* Memoizes the compatibility results.
- *
*
* @param reader Reader schema to test.
* @param writer Writer schema to test.
@@ -214,7 +214,7 @@ public SchemaCompatibilityResult getCompatibility(final Schema reader, final Sch
* Reports the compatibility of a reader/writer schema pair.
*
* Memoizes the compatibility results.
- *
*
* @param referenceToken The equivalent JSON pointer reference token
* representation of the schema node being visited.
@@ -252,7 +252,7 @@ private SchemaCompatibilityResult getCompatibility(String referenceToken, final
*
* Relies on external memoization performed by
* {@link #getCompatibility(Schema, Schema)}.
- *
*
* @param reader Reader schema to test.
* @param writer Writer schema to test.
diff --git a/lang/java/avro/src/main/java/org/apache/avro/SchemaFormatter.java b/lang/java/avro/src/main/java/org/apache/avro/SchemaFormatter.java
index dee5382a19f..72ffddd0fc7 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/SchemaFormatter.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/SchemaFormatter.java
@@ -26,7 +26,7 @@
*
* Schema formats have a name, and optionally a variant (all lowercase). The
* Avro library supports a few formats out of the box:
- *
*
*
*
* @return the name of the format
*/
@@ -80,7 +80,7 @@ default String formatName() {
* Implementations should either return the only formatter for this format, or
* call {@link #getFormatterForVariant(String)} with the default variant and
* implement that method as well.
- *
*
* @return the default formatter for this schema format
*/
diff --git a/lang/java/avro/src/main/java/org/apache/avro/SchemaParser.java b/lang/java/avro/src/main/java/org/apache/avro/SchemaParser.java
index 295cb778e3f..1513ee94131 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/SchemaParser.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/SchemaParser.java
@@ -41,13 +41,13 @@
* first result. This means it can transparently handle any schema format. The
* Avro project defines a JSON based format and an IDL format (the latter
* available as a separate dependency), but you can also provide your own.
- *
*
*
* The parser can handle various text based sources. If the source contains a
* UTF encoded latin text based format it can even detect which UTF encoding was
* used (UTF-8, UTF16BE, UTF16LE, UTF-32BE or UTF32LE).
- *
*
* @see FormattedSchemaParser
* @see UtfTextUtils
@@ -59,7 +59,7 @@ public class SchemaParser {
/**
*
* Use a default SchemaParser to parse a single schema. Equivalent to:
- *
*
* Use a default SchemaParser to parse a single schema from a file. Equivalent
* to:
- *
*
* Initially, the list of known (named) schemata is empty.
- *
*
* Note: using {@link NameValidator#STRICT_VALIDATOR} to validate names is
* advised for maximum interoperability.
- *
*
* @param nameValidator the name validator to use
*/
diff --git a/lang/java/avro/src/main/java/org/apache/avro/SchemaValidationStrategy.java b/lang/java/avro/src/main/java/org/apache/avro/SchemaValidationStrategy.java
index 881aa365654..b8297b82a97 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/SchemaValidationStrategy.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/SchemaValidationStrategy.java
@@ -23,7 +23,7 @@
* another.
*
* What makes one schema compatible with another is not defined by the contract.
- *
*/
public interface SchemaValidationStrategy {
diff --git a/lang/java/avro/src/main/java/org/apache/avro/SchemaValidator.java b/lang/java/avro/src/main/java/org/apache/avro/SchemaValidator.java
index d1dee747d51..430cc6e6081 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/SchemaValidator.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/SchemaValidator.java
@@ -22,11 +22,11 @@
*
* A SchemaValidator has one method, which validates that a {@link Schema} is
* compatible with the other schemas provided.
- *
*
* What makes one Schema compatible with another is not part of the interface
* contract.
- *
*/
public interface SchemaValidator {
diff --git a/lang/java/avro/src/main/java/org/apache/avro/SchemaValidatorBuilder.java b/lang/java/avro/src/main/java/org/apache/avro/SchemaValidatorBuilder.java
index a10e0408ba4..514485d9467 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/SchemaValidatorBuilder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/SchemaValidatorBuilder.java
@@ -21,7 +21,7 @@
/**
*
* A Builder for creating SchemaValidators.
- *
*/
public final class SchemaValidatorBuilder {
private SchemaValidationStrategy strategy;
diff --git a/lang/java/avro/src/main/java/org/apache/avro/SystemLimitException.java b/lang/java/avro/src/main/java/org/apache/avro/SystemLimitException.java
index 003f2e406fd..86faa24c1f9 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/SystemLimitException.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/SystemLimitException.java
@@ -24,7 +24,7 @@
/**
* Thrown to prevent making large allocations when reading potentially
* pathological input data from an untrusted source.
- *
* The following system properties can be set to limit the size of bytes,
* strings and collection types to be allocated:
*
* A {@link SchemaValidator} for validating the provided schema against all
* schemas in the Iterable in {@link #validate(Schema, Iterable)}.
- *
*
* Uses the {@link SchemaValidationStrategy} provided in the constructor to
* validate the {@link Schema} against each Schema in the Iterable, in Iterator
* order, via {@link SchemaValidationStrategy#validate(Schema, Schema)}.
- *
*/
public final class ValidateAll implements SchemaValidator {
private final SchemaValidationStrategy strategy;
diff --git a/lang/java/avro/src/main/java/org/apache/avro/ValidateLatest.java b/lang/java/avro/src/main/java/org/apache/avro/ValidateLatest.java
index ef75cd31aa3..ecaf8060fb9 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/ValidateLatest.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/ValidateLatest.java
@@ -24,12 +24,12 @@
*
* A {@link SchemaValidator} for validating the provided schema against the
* first {@link Schema} in the iterable in {@link #validate(Schema, Iterable)}.
- *
*
* Uses the {@link SchemaValidationStrategy} provided in the constructor to
* validate the schema against the first Schema in the iterable, if it exists,
* via {@link SchemaValidationStrategy#validate(Schema, Schema)}.
- *
*/
public final class ValidateLatest implements SchemaValidator {
private final SchemaValidationStrategy strategy;
diff --git a/lang/java/avro/src/main/java/org/apache/avro/file/DataFileWriter.java b/lang/java/avro/src/main/java/org/apache/avro/file/DataFileWriter.java
index 466fa28135c..055353c1f5f 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/file/DataFileWriter.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/file/DataFileWriter.java
@@ -380,7 +380,7 @@ private void writeIfBlockFull() throws IOException {
* files are compatible, data blocks are copied directly without decompression.
* If the codecs are not compatible, blocks from otherFile are uncompressed and
* then compressed using this file's codec.
- *
* If the recompress flag is set all blocks are decompressed and then compressed
* using this file's codec. This is useful when the two files have compatible
* compression codecs but different codec options. For example, one might append
diff --git a/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java b/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java
index ebbac9a3228..9f1837628e3 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/generic/GenericData.java
@@ -88,7 +88,7 @@ public class GenericData {
/** Used to specify the Java type for a string schema. */
public enum StringType {
CharSequence, String, Utf8
- };
+ }
public static final String STRING_PROP = "avro.java.string";
protected static final String STRING_TYPE_STRING = "String";
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/BinaryDecoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/BinaryDecoder.java
index 3974eb5c621..fbd78f7d90d 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/BinaryDecoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/BinaryDecoder.java
@@ -32,14 +32,14 @@
/**
* An {@link Decoder} for binary-format data.
- *
* Instances are created using {@link DecoderFactory}.
- *
* This class may read-ahead and buffer bytes from the source beyond what is
* required to serve its read methods. The number of unused bytes in the buffer
* can be accessed by inputStream().remaining(), if the BinaryDecoder is not
* 'direct'.
- *
*
* @see Encoder
* @see SystemLimitException
@@ -120,7 +120,7 @@ BinaryDecoder configure(byte[] data, int offset, int length) {
* it exists) from this Decoder. The old source's state no longer depends on
* this Decoder and its InputStream interface will continue to drain the
* remaining buffer and source data.
- *
* The decoder will read from the new source. The source will generally replace
* the buffer with its own. If the source allocates a new buffer, it will create
* it with size bufferSize.
@@ -510,7 +510,7 @@ public int readIndex() throws IOException {
* Returns true if the current BinaryDecoder is at the end of its source data
* and cannot read any further without throwing an EOFException or other
* IOException.
- *
* Not all implementations of BinaryDecoder support isEnd(). Implementations
* that do not support isEnd() will throw a
* {@link java.lang.UnsupportedOperationException}.
@@ -553,12 +553,12 @@ public int remainingBytes() {
* Ensures that buf[pos + num - 1] is not out of the buffer array bounds.
* However, buf[pos + num -1] may be >= limit if there is not enough data left
* in the source to fill the array with num bytes.
- *
* This method allows readers to read ahead by num bytes safely without checking
* for EOF at each byte. However, readers must ensure that their reads are valid
* by checking that their read did not advance past the limit before adjusting
* pos.
- *
* num must be less than the buffer size and greater than 0
*/
private void ensureBounds(int num) throws IOException {
@@ -688,16 +688,16 @@ void setBuf(byte[] buf, int offset, int length) {
* InputStream's API is a barrier to performance due to several quirks:
* InputStream does not in general require that as many bytes as possible have
* been read when filling a buffer.
- *
* InputStream's terminating conditions for a read are two-fold: EOFException
* and '-1' on the return from read(). Implementations are supposed to return
* '-1' on EOF but often do not. The extra terminating conditions cause extra
* conditionals on both sides of the API, and slow performance significantly.
- *
* ByteSource implementations provide read() and skip() variants that have
* stronger guarantees than InputStream, freeing client code to be simplified
* and faster.
- *
* {@link #skipSourceBytes} and {@link #readRaw} are guaranteed to have read or
* skipped as many bytes as possible, or throw EOFException.
* {@link #trySkipBytes} and {@link #tryReadRaw} are guaranteed to attempt to
@@ -707,7 +707,7 @@ void setBuf(byte[] buf, int offset, int length) {
* also be detected by a client if an EOFException is thrown from
* {@link #skipSourceBytes} or {@link #readRaw}, or if {@link #trySkipBytes} or
* {@link #tryReadRaw} return 0;
- *
* A ByteSource also implements the InputStream contract for use by APIs that
* require it. The InputStream interface must take into account buffering in any
* decoder that this ByteSource is attached to. The other methods do not account
@@ -779,7 +779,7 @@ protected void detach() {
* Attempts to copy up to len bytes from the source into data, starting
* at index off. Returns the actual number of bytes copied which may be
* between 0 and len.
- *
* This method must attempt to read as much as possible from the source. Returns
* 0 when at the end of stream/channel/file/etc.
*
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/BinaryEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/BinaryEncoder.java
index 97d9895c74f..60d54718e25 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/BinaryEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/BinaryEncoder.java
@@ -25,7 +25,7 @@
/**
* An abstract {@link Encoder} for Avro's binary encoding.
- *
* To construct and configure instances, use {@link EncoderFactory}
*
* @see EncoderFactory
@@ -167,7 +167,7 @@ public void writeIndex(int unionIndex) throws IOException {
/**
* Returns the number of bytes currently buffered by this encoder. If this
* Encoder does not buffer, this will always return zero.
- *
* Call {@link #flush()} to empty the buffer to the underlying output.
*/
public abstract int bytesBuffered();
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/BlockingBinaryEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/BlockingBinaryEncoder.java
index 9a0d9e414b0..5501df234e0 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/BlockingBinaryEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/BlockingBinaryEncoder.java
@@ -31,13 +31,13 @@
* arbitrarily long arrays and maps may be written and subsequently read without
* exhausting memory. Values are buffered until the specified block size would
* be exceeded, minimizing block overhead.
- *
* Use {@link EncoderFactory#blockingBinaryEncoder(OutputStream, BinaryEncoder)}
* to construct and configure.
- *
* BlockingBinaryEncoder buffers writes, data may not appear on the output until
* {@link #flush()} is called.
- *
* BlockingBinaryEncoder is not thread-safe
*
* @see BinaryEncoder
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/BlockingDirectBinaryEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/BlockingDirectBinaryEncoder.java
index 9f391a31921..e668abba0c3 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/BlockingDirectBinaryEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/BlockingDirectBinaryEncoder.java
@@ -26,19 +26,19 @@
/**
* An {@link Encoder} for Avro's binary encoding that does not buffer output.
- *
* This encoder does not buffer writes in contrast to
* {@link BufferedBinaryEncoder}. However, it is lighter-weight and useful when:
* The buffering in BufferedBinaryEncoder is not desired because you buffer a
* different level or the Encoder is very short-lived.
- *
* The BlockingDirectBinaryEncoder will encode the number of bytes of the Map
* and Array blocks. This will allow to postpone the decoding, or skip over it
* at all.
- *
* To construct, use
* {@link EncoderFactory#blockingDirectBinaryEncoder(OutputStream, BinaryEncoder)}
- *
* {@link BlockingDirectBinaryEncoder} instances returned by this method are not
* thread-safe
*
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/BufferedBinaryEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/BufferedBinaryEncoder.java
index b0dfa4faf67..d8379f3f216 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/BufferedBinaryEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/BufferedBinaryEncoder.java
@@ -28,17 +28,17 @@
/**
* An {@link Encoder} for Avro's binary encoding.
- *
* This implementation buffers output to enhance performance. Output may not
* appear on the underlying output until flush() is called.
- *
* {@link DirectBinaryEncoder} can be used in place of this implementation if
* the buffering semantics are not desired, and the performance difference is
* acceptable.
- *
* To construct or reconfigure, use
* {@link EncoderFactory#binaryEncoder(OutputStream, BinaryEncoder)}.
- *
* To change the buffer size, configure the factory instance used to create
* instances with {@link EncoderFactory#configureBufferSize(int)}
*
@@ -190,11 +190,11 @@ public int bytesBuffered() {
/**
* ByteSink abstracts the destination of written data from the core workings of
* BinaryEncoder.
- *
* Currently the only destination option is an OutputStream, but we may later
* want to handle other constructs or specialize for certain OutputStream
* Implementations such as ByteBufferOutputStream.
- *
*/
private abstract static class ByteSink {
protected ByteSink() {
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/Decoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/Decoder.java
index 80640a61aa0..c9ba8ea4a7e 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/Decoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/Decoder.java
@@ -24,14 +24,14 @@
/**
* Low-level support for de-serializing Avro values.
- *
* This class has two types of methods. One type of methods support the reading
* of leaf values (for example, {@link #readLong} and {@link #readString}).
- *
* The other type of methods support the reading of maps and arrays. These
* methods are {@link #readArrayStart}, {@link #arrayNext}, and similar methods
* for maps. See {@link #readArrayStart} for details on these methods.
- *
* {@link DecoderFactory} contains Decoder construction and configuration
* facilities.
*
@@ -243,18 +243,22 @@ public void readFixed(byte[] bytes) throws IOException {
* consisting of a Long field and a Boolean field. Your code would look
* something like this:
*
+ *
*
*
* Although Factories are thread-safe the {@link Decoder}s they return are not.
- *
*
* @see Decoder
*/
@@ -111,13 +111,13 @@ public BinaryDecoder createBinaryDecoder(InputStream in, BinaryDecoder reuse) {
* Creates or reinitializes a {@link BinaryDecoder} with the input stream
* provided as the source of data. If reuse is provided, it will be
* reinitialized to the given input stream.
- *
* {@link BinaryDecoder} instances returned by this method buffer their input,
* reading up to {@link #getConfiguredBufferSize()} bytes past the minimum
* required to satisfy read requests in order to achieve better performance. If
* the buffering is not desired, use
* {@link #directBinaryDecoder(InputStream, BinaryDecoder)}.
- *
* {@link BinaryDecoder#inputStream()} provides a view on the data that is
* buffer-aware, for users that need to interleave access to data with the
* Decoder API.
@@ -146,17 +146,17 @@ public BinaryDecoder binaryDecoder(InputStream in, BinaryDecoder reuse) {
* Creates or reinitializes a {@link BinaryDecoder} with the input stream
* provided as the source of data. If reuse is provided, it will be
* reinitialized to the given input stream.
- *
* {@link BinaryDecoder} instances returned by this method do not buffer their
* input. In most cases a buffering BinaryDecoder is sufficient in combination
* with {@link BinaryDecoder#inputStream()} which provides a buffer-aware view
* on the data.
- *
* A "direct" BinaryDecoder does not read ahead from an InputStream or other
* data source that cannot be rewound. From the perspective of a client, a
* "direct" decoder must never read beyond the minimum necessary bytes to
* service a {@link BinaryDecoder} API read request.
- *
* In the case that the improved performance of a buffering implementation does
* not outweigh the inconvenience of its buffering semantics, a "direct" decoder
* can be used.
@@ -199,7 +199,7 @@ public BinaryDecoder createBinaryDecoder(byte[] bytes, int offset, int length, B
* as the source of data. If reuse is provided, it will attempt to
* reinitialize reuse to the new byte array. This instance will use the
* provided byte array as its buffer.
- *
* {@link BinaryDecoder#inputStream()} provides a view on the data that is
* buffer-aware and can provide a view of the data not yet read by Decoder API
* methods.
@@ -245,7 +245,7 @@ public BinaryDecoder binaryDecoder(byte[] bytes, BinaryDecoder reuse) {
/**
* Creates a {@link JsonDecoder} using the InputStream provided for reading data
* that conforms to the Schema provided.
- *
*
* @param schema The Schema for data read from this JsonEncoder. Cannot be null.
* @param input The InputStream to read from. Cannot be null.
@@ -259,7 +259,7 @@ public JsonDecoder jsonDecoder(Schema schema, InputStream input) throws IOExcept
/**
* Creates a {@link JsonDecoder} using the String provided for reading data that
* conforms to the Schema provided.
- *
*
* @param schema The Schema for data read from this JsonEncoder. Cannot be null.
* @param input The String to read from. Cannot be null.
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/DirectBinaryDecoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/DirectBinaryDecoder.java
index ac251550da2..de4c0638110 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/DirectBinaryDecoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/DirectBinaryDecoder.java
@@ -28,7 +28,7 @@
/**
* A non-buffering version of {@link BinaryDecoder}.
- *
* This implementation will not read-ahead from the provided InputStream beyond
* the minimum required to service the API requests.
*
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/DirectBinaryEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/DirectBinaryEncoder.java
index df7c118b648..0f22592e43f 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/DirectBinaryEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/DirectBinaryEncoder.java
@@ -23,15 +23,15 @@
/**
* An {@link Encoder} for Avro's binary encoding that does not buffer output.
- *
* This encoder does not buffer writes, and as a result is slower than
* {@link BufferedBinaryEncoder}. However, it is lighter-weight and useful when
* the buffering in BufferedBinaryEncoder is not desired and/or the Encoder is
* very short-lived.
- *
* To construct, use
* {@link EncoderFactory#directBinaryEncoder(OutputStream, BinaryEncoder)}
- *
* DirectBinaryEncoder is not thread-safe
*
* @see BinaryEncoder
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java
index 85d5c421fb6..5c04676e1ed 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/Encoder.java
@@ -25,18 +25,18 @@
/**
* Low-level support for serializing Avro values.
- *
* This class has two types of methods. One type of methods support the writing
* of leaf values (for example, {@link #writeLong} and {@link #writeString}).
* These methods have analogs in {@link Decoder}.
- *
* The other type of methods support the writing of maps and arrays. These
* methods are {@link #writeArrayStart}, {@link #startItem}, and
* {@link #writeArrayEnd} (and similar methods for maps). Some implementations
* of {@link Encoder} handle the buffering required to break large maps and
* arrays into blocks, which is necessary for applications that want to do
* streaming. (See {@link #writeArrayStart} for details on these methods.)
- *
* {@link EncoderFactory} contains Encoder construction and configuration
* facilities.
*
@@ -272,6 +272,7 @@ public void writeFixed(ByteBuffer bytes) throws IOException {
* something like this:
*
*
* Factory methods that create Encoder instances are thread-safe. Multiple
* instances with different configurations can be cached by an application.
*
@@ -131,7 +131,7 @@ public EncoderFactory configureBlockSize(int size) {
* {@link BinaryEncoder} instances created with
* #blockingBinaryEncoder(OutputStream, BinaryEncoder) will have block buffers
* of this size.
- *
*
* @see #configureBlockSize(int)
* @see #blockingBinaryEncoder(OutputStream, BinaryEncoder)
@@ -146,15 +146,15 @@ public int getBlockSize() {
* provided as the destination for written data. If reuse is provided, an
* attempt will be made to reconfigure reuse rather than construct a new
* instance, but this is not guaranteed, a new instance may be returned.
- *
* The {@link BinaryEncoder} implementation returned may buffer its output. Data
* may not appear on the underlying OutputStream until {@link Encoder#flush()}
* is called. The buffer size is configured with
* {@link #configureBufferSize(int)}.
- *
* If buffering is not desired, and lower performance is acceptable, use
* {@link #directBinaryEncoder(OutputStream, BinaryEncoder)}
- *
* {@link BinaryEncoder} instances returned by this method are not thread-safe
*
* @param out The OutputStream to write to. Cannot be null.
@@ -182,18 +182,18 @@ public BinaryEncoder binaryEncoder(OutputStream out, BinaryEncoder reuse) {
* provided as the destination for written data. If reuse is provided, an
* attempt will be made to reconfigure reuse rather than construct a new
* instance, but this is not guaranteed, a new instance may be returned.
- *
* The {@link BinaryEncoder} implementation returned does not buffer its output,
* calling {@link Encoder#flush()} will simply cause the wrapped OutputStream to
* be flushed.
- *
* Performance of unbuffered writes can be significantly slower than buffered
* writes. {@link #binaryEncoder(OutputStream, BinaryEncoder)} returns
* BinaryEncoder instances that are tuned for performance but may buffer output.
* The unbuffered, 'direct' encoder may be desired when buffering semantics are
* problematic, or if the lifetime of the encoder is so short that the buffer
* would not be useful.
- *
* {@link BinaryEncoder} instances returned by this method are not thread-safe.
*
* @param out The OutputStream to initialize to. Cannot be null.
@@ -222,21 +222,21 @@ public BinaryEncoder directBinaryEncoder(OutputStream out, BinaryEncoder reuse)
* provided, an attempt will be made to reconfigure reuse rather than
* construct a new instance, but this is not guaranteed, a new instance may be
* returned.
- *
* The {@link BinaryEncoder} implementation returned does not buffer its output,
* calling {@link Encoder#flush()} will simply cause the wrapped OutputStream to
* be flushed.
- *
* The {@link BlockingDirectBinaryEncoder} will write the block sizes for the
* arrays and maps so efficient skipping can be done.
- *
* Performance of unbuffered writes can be significantly slower than buffered
* writes. {@link #binaryEncoder(OutputStream, BinaryEncoder)} returns
* BinaryEncoder instances that are tuned for performance but may buffer output.
* The unbuffered, 'direct' encoder may be desired when buffering semantics are
* problematic, or if the lifetime of the encoder is so short that the buffer
* would not be useful.
- *
* {@link BinaryEncoder} instances returned by this method are not thread-safe.
*
* @param out The OutputStream to initialize to. Cannot be null.
@@ -264,17 +264,17 @@ public BinaryEncoder blockingDirectBinaryEncoder(OutputStream out, BinaryEncoder
* provided as the destination for written data. If reuse is provided, an
* attempt will be made to reconfigure reuse rather than construct a new
* instance, but this is not guaranteed, a new instance may be returned.
- *
* The {@link BinaryEncoder} implementation returned buffers its output, calling
* {@link Encoder#flush()} is required for output to appear on the underlying
* OutputStream.
- *
* The returned BinaryEncoder implements the Avro binary encoding using blocks
* delimited with byte sizes for Arrays and Maps. This allows for some decoders
* to skip over large Arrays or Maps without decoding the contents, but adds
* some overhead. The default block size is configured with
* {@link #configureBlockSize(int)}
- *
* {@link BinaryEncoder} instances returned by this method are not thread-safe.
*
* @param out The OutputStream to initialize to. Cannot be null.
@@ -302,10 +302,10 @@ public BinaryEncoder blockingBinaryEncoder(OutputStream out, BinaryEncoder reuse
/**
* Creates a {@link JsonEncoder} using the OutputStream provided for writing
* data conforming to the Schema provided.
- *
* {@link JsonEncoder} buffers its output. Data may not appear on the underlying
* OutputStream until {@link Encoder#flush()} is called.
- *
* {@link JsonEncoder} is not thread-safe.
*
* @param schema The Schema for data written to this JsonEncoder. Cannot be
@@ -321,10 +321,10 @@ public JsonEncoder jsonEncoder(Schema schema, OutputStream out) throws IOExcepti
/**
* Creates a {@link JsonEncoder} using the OutputStream provided for writing
* data conforming to the Schema provided with optional pretty printing.
- *
* {@link JsonEncoder} buffers its output. Data may not appear on the underlying
* OutputStream until {@link Encoder#flush()} is called.
- *
* {@link JsonEncoder} is not thread-safe.
*
* @param schema The Schema for data written to this JsonEncoder. Cannot be
@@ -342,10 +342,10 @@ public JsonEncoder jsonEncoder(Schema schema, OutputStream out, boolean pretty)
/**
* Creates a {@link JsonEncoder} using the OutputStream provided for writing
* data conforming to the Schema provided with optional pretty printing.
- *
* {@link JsonEncoder} buffers its output. Data may not appear on the underlying
* OutputStream until {@link Encoder#flush()} is called.
- *
* {@link JsonEncoder} is not thread-safe.
*
* @param schema The Schema for data written to this JsonEncoder. Cannot be
@@ -374,10 +374,10 @@ public JsonEncoder jsonEncoder(Schema schema, OutputStream out, boolean pretty,
/**
* Creates a {@link JsonEncoder} using the {@link JsonGenerator} provided for
* output of data conforming to the Schema provided.
- *
* {@link JsonEncoder} buffers its output. Data may not appear on the underlying
* output until {@link Encoder#flush()} is called.
- *
* {@link JsonEncoder} is not thread-safe.
*
* @param schema The Schema for data written to this JsonEncoder. Cannot be
@@ -394,10 +394,10 @@ JsonEncoder jsonEncoder(Schema schema, JsonGenerator gen) throws IOException {
* Creates a {@link ValidatingEncoder} that wraps the Encoder provided. This
* ValidatingEncoder will ensure that operations against it conform to the
* schema provided.
- *
* Many {@link Encoder}s buffer their output. Data may not appear on the
* underlying output until {@link Encoder#flush()} is called.
- *
* {@link ValidatingEncoder} is not thread-safe.
*
* @param schema The Schema to validate operations against. Cannot be null.
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/JsonDecoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/JsonDecoder.java
index 1876f87aaac..b921031f8e8 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/JsonDecoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/JsonDecoder.java
@@ -40,9 +40,9 @@
/**
* A {@link Decoder} for Avro's JSON data encoding.
- *
* Construct using {@link DecoderFactory}.
- *
* JsonDecoder is not thread-safe.
*/
public class JsonDecoder extends ParsingDecoder implements Parser.ActionHandler {
@@ -81,9 +81,9 @@ private static Symbol getSymbol(Schema schema) {
/**
* Reconfigures this JsonDecoder to use the InputStream provided.
- *
* If the InputStream provided is null, a NullPointerException is thrown.
- *
* Otherwise, this JsonDecoder will reset its state and then reconfigure its
* input.
*
@@ -104,9 +104,9 @@ public JsonDecoder configure(InputStream in) throws IOException {
/**
* Reconfigures this JsonDecoder to use the String provided for input.
- *
* If the String provided is null, a NullPointerException is thrown.
- *
* Otherwise, this JsonDecoder will reset its state and then reconfigure its
* input.
*
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/JsonEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/JsonEncoder.java
index 4613f403d04..8b72d4b7994 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/JsonEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/JsonEncoder.java
@@ -41,12 +41,12 @@
/**
* An {@link Encoder} for Avro's JSON data encoding.
- *
* Construct using {@link EncoderFactory}.
- *
* JsonEncoder buffers output, and data may not appear on the output until
* {@link Encoder#flush()} is called.
- *
* JsonEncoder is not thread-safe.
*/
public class JsonEncoder extends ParsingEncoder implements Parser.ActionHandler {
@@ -120,9 +120,9 @@ public void setIncludeNamespace(final boolean includeNamespace) {
/**
* Reconfigures this JsonEncoder to use the output stream provided.
- *
* If the OutputStream provided is null, a NullPointerException is thrown.
- *
* Otherwise, this JsonEncoder will flush its current output and then
* reconfigure its output to use a default UTF8 JsonGenerator that writes to the
* provided OutputStream.
@@ -138,9 +138,9 @@ public JsonEncoder configure(OutputStream out) throws IOException {
/**
* Reconfigures this JsonEncoder to use the output stream provided.
- *
* If the OutputStream provided is null, a NullPointerException is thrown.
- *
* Otherwise, this JsonEncoder will flush its current output and then
* reconfigure its output to use a default UTF8 JsonGenerator that writes to the
* provided OutputStream.
@@ -161,9 +161,9 @@ public JsonEncoder configure(OutputStream out, boolean autoflush) throws IOExcep
/**
* Reconfigures this JsonEncoder to output to the JsonGenerator provided.
- *
* If the JsonGenerator provided is null, a NullPointerException is thrown.
- *
* Otherwise, this JsonEncoder will flush its current output and then
* reconfigure its output to use the provided JsonGenerator.
*
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/ValidatingDecoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/ValidatingDecoder.java
index 3c5e0842189..6a84885e510 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/ValidatingDecoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/ValidatingDecoder.java
@@ -31,10 +31,10 @@
/**
* An implementation of {@link Decoder} that ensures that the sequence of
* operations conforms to a schema.
- *
* Use {@link DecoderFactory#validatingDecoder(Schema, Decoder)} to construct
* and configure.
- *
* ValidatingDecoder is not thread-safe.
*
* @see Decoder
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/ValidatingEncoder.java b/lang/java/avro/src/main/java/org/apache/avro/io/ValidatingEncoder.java
index d61967751a0..a64e295d165 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/ValidatingEncoder.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/ValidatingEncoder.java
@@ -31,10 +31,10 @@
/**
* An implementation of {@link Encoder} that wraps another Encoder and ensures
* that the sequence of operations conforms to the provided schema.
- *
* Use {@link EncoderFactory#validatingEncoder(Schema, Encoder)} to construct
* and configure.
- *
* ValidatingEncoder is not thread-safe.
*
* @see Encoder
diff --git a/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java b/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java
index dbed69d79bb..29345c56f74 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/specific/SpecificData.java
@@ -246,8 +246,8 @@ public static
* A temporal amount to model an {@link org.apache.avro.LogicalTypes.Duration
* Avro duration} (the logical type).
- *
*
*
* It consists of a number of months, days and milliseconds, all modelled as an
* unsigned integer.
- *
*
*
* Compared to {@link Period java.time.Period}, this class has a smaller range
* ('only' supporting a little less than 358 million years), and cannot support
* negative periods.
- *
*
*
* Compared to {@link Duration java.time.Duration}, this class has less
@@ -61,11 +61,11 @@
* durations, and has a much smaller range. Where {@code java.time.Duration}
* supports fixed ranges up to about 68 years, {@code TimePeriod} can only
* handle about 49 days.
- *
*
*
* Comparison with the regular {@code java.time} classes:
- *
*
*
*
* @see XML specification,
* appendix F: Autodetection of Character Encodings (Non-Normative)
@@ -141,14 +141,14 @@ private static String skipBOM(CharSequence buffer) {
* To ensure the most accurate detection, the algorithm requires at least 4
* bytes. One should only provide less than 4 bytes of data if that is all there
* is.
- *
*
*
* Detection is certain when a byte order mark (BOM) is used. Otherwise a
* heuristic is used, which works when the first character is from the first 256
* characters from the BMP (U+0000-U+00FF). This works for all latin-based
* textual formats, like Avro IDL, JSON, YAML, XML, etc.
- *
*
* @param firstFewBytes the first few bytes of the text to detect the character
* set of
diff --git a/lang/java/compiler/src/main/java/org/apache/avro/compiler/specific/SpecificCompiler.java b/lang/java/compiler/src/main/java/org/apache/avro/compiler/specific/SpecificCompiler.java
index 32a7d97cca0..4d5403390cc 100644
--- a/lang/java/compiler/src/main/java/org/apache/avro/compiler/specific/SpecificCompiler.java
+++ b/lang/java/compiler/src/main/java/org/apache/avro/compiler/specific/SpecificCompiler.java
@@ -249,8 +249,8 @@ public boolean isCreateNullSafeAnnotations() {
* Set to true to add @Nullable and @NotNull annotations. By default, JetBrains
* annotations are used (org.jetbrains.annotations.Nullable and
* org.jetbrains.annotations.NotNull) but this can be overridden using
- * {@link #setNullSafeAnnotationNullable)} and
- * {@link #setNullSafeAnnotationNotNull)}.
+ * {@link #setNullSafeAnnotationNullable} and
+ * {@link #setNullSafeAnnotationNotNull}.
*/
public void setCreateNullSafeAnnotations(boolean createNullSafeAnnotations) {
this.createNullSafeAnnotations = createNullSafeAnnotations;
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/SortedKeyValueFile.java b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/SortedKeyValueFile.java
index 247f0434e67..b8bd929b876 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/SortedKeyValueFile.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/file/SortedKeyValueFile.java
@@ -56,11 +56,11 @@
* keys in the 'data' file to their byte positions. The index file is intended
* to fit in memory, so it should remain small. There is one entry in the index
* file for each data block in the Avro container file.
- *
*
*
* SortedKeyValueFile is to Avro container file as MapFile is to SequenceFile.
- *
*/
public class SortedKeyValueFile {
private static final Logger LOG = LoggerFactory.getLogger(SortedKeyValueFile.class);
@@ -79,7 +79,7 @@ public class SortedKeyValueFile {
* using the key index. It performs a single disk seek to the block and loads
* the entire block into memory. The block is scanned until the key is found or
* is determined not to exist.
- *
*
* @param
* This method will move the current position in the file to the record
* immediately following the requested key.
- *
*
* @param key The key to look up.
* @return The value associated with the key, or null if not found.
@@ -281,12 +281,12 @@ public V get(K key) throws IOException {
*
*
* Use the get() method to move the current position.
- *
*
*
* Note that this iterator is shared with other clients of the file; it does not
* contain a separate pointer into the file.
- *
*
* @return An iterator.
*/
@@ -488,7 +488,7 @@ public Path getPath() {
*
* If the index inverval is N, then every N records will be indexed into the
* index file.
- *
*
* @param indexInterval The index interval.
* @return This options instance.
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDatumConverterFactory.java b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDatumConverterFactory.java
index a9984e08e54..da55b857f0b 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDatumConverterFactory.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDatumConverterFactory.java
@@ -59,7 +59,7 @@
*
*/
public class AvroDatumConverterFactory extends Configured {
/**
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java
index 053c77a9197..2c35dec41c5 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroDeserializer.java
@@ -38,13 +38,13 @@
* of the WritableSerialization model, so they are wrapper in
* {@link org.apache.avro.mapred.AvroWrapper} objects and deserialization is
* handled by this class.
- *
*
*
* MapReduce jobs that use AvroWrapper objects as keys or values need to be
* configured with {@link AvroSerialization}. Use
* {@link org.apache.avro.mapreduce.AvroJob} to help with Job configuration.
- *
*
* @param
* Compares AvroKeys output from the map phase for sorting.
- *
*/
public class AvroKeyComparator
*
*
*
*
* The solution implemented in
*
*
*
* @param options The options for the writer.
* @return A new writer instance.
@@ -202,7 +202,7 @@ public Options withOutputPath(Path outputPath) {
* {@link #withKeySchema(org.apache.avro.Schema)} to specify the writer schema.
* The key class will be automatically set to
* {@link org.apache.avro.mapred.AvroKey}.
- *
*
* @param keyClass The key class.
* @return This options instance.
@@ -222,7 +222,7 @@ public Options withKeyClass(Class> keyClass) {
* The key class will automatically be set to
* {@link org.apache.avro.mapred.AvroKey}, so there is no need to call
* {@link #withKeyClass(Class)} when using this method.
- *
*
* @param keyWriterSchema The writer schema for the keys.
* @return This options instance.
@@ -244,7 +244,7 @@ public Options withKeySchema(Schema keyWriterSchema) {
* {@link #withValueSchema(org.apache.avro.Schema)} to specify the writer
* schema. The value class will be automatically set to
* {@link org.apache.avro.mapred.AvroValue}.
- *
*
* @param valueClass The value class.
* @return This options instance.
@@ -264,7 +264,7 @@ public Options withValueClass(Class> valueClass) {
* The value class will automatically be set to
* {@link org.apache.avro.mapred.AvroValue}, so there is no need to call
* {@link #withValueClass(Class)} when using this method.
- *
*
* @param valueWriterSchema The writer schema for the values.
* @return This options instance.
@@ -614,7 +614,7 @@ public Options withConfiguration(Configuration conf) {
*
*
* If not set, the writer schema will be used as the reader schema.
- *
*
* @param keyReaderSchema The reader schema for the keys.
* @return This options instance.
@@ -629,7 +629,7 @@ public Options withKeySchema(Schema keyReaderSchema) {
*
*
* If not set, the writer schema will be used as the reader schema.
- *
*
* @param valueReaderSchema The reader schema for the values.
* @return This options instance.
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java
index f30626c91cb..9e938445e9a 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/hadoop/io/AvroSerializer.java
@@ -37,13 +37,13 @@
* of the WritableSerialization model, so they are wrapped in
* {@link org.apache.avro.mapred.AvroWrapper} objects and serialization is
* handled by this class.
- *
*
*
* MapReduce jobs that use AvroWrapper objects as keys or values need to be
* configured with {@link AvroSerialization}. Use
* {@link org.apache.avro.mapreduce.AvroJob} to help with Job configuration.
- *
*
* @param
*
*
* Using this comparator enables comparisons between
*
* @param
* Usage:
- *
*
* Case 1: (ReflectData based inputs)
- *
*
*
* Case 2: (SpecificData based inputs)
- *
*
*
* Note on InputFormat: The InputFormat used will always be
* {@link AvroInputFormat} when using this class.
- *
*
* Note on collector outputs: When using this class, you will
* need to ensure that the mapper implementations involved must all emit the
* same Key type and Value record types, as set by
* {@link AvroJob#setOutputSchema(JobConf, Schema)} or
* {@link AvroJob#setMapOutputSchema(JobConf, Schema)}.
- *
*/
public class AvroMultipleInputs {
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java b/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java
index 20bd29c216c..5735a663203 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroMultipleOutputs.java
@@ -50,10 +50,10 @@
*
*
* Case two: to write data to different files provided by user
- *
*
*
* AvroMultipleOutputs supports counters, by default they are disabled. The
@@ -62,7 +62,7 @@
* records written to each output name. For multi named outputs the name of the
* counter is the concatenation of the named output, and underscore '_' and the
* multiname.
- *
*
* Usage pattern for job submission:
*
@@ -246,7 +246,7 @@ public static Class extends OutputFormat> getNamedOutputFormatClass(JobConf co
/**
* Adds a named output for the job.
- *
*
* @param conf job conf to add the named output
* @param namedOutput named output name, it has to be a word, letters and
@@ -262,7 +262,7 @@ public static void addNamedOutput(JobConf conf, String namedOutput, Class exte
/**
* Adds a multi named output for the job.
- *
*
* @param conf job conf to add the named output
* @param namedOutput named output name, it has to be a word, letters and
@@ -278,7 +278,7 @@ public static void addMultiNamedOutput(JobConf conf, String namedOutput,
/**
* Adds a named output for the job.
- *
*
* @param conf job conf to add the named output
* @param namedOutput named output name, it has to be a word, letters and
@@ -301,12 +301,12 @@ private static void addNamedOutput(JobConf conf, String namedOutput, boolean mul
/**
* Enables or disables counters for the named outputs.
- *
* By default these counters are disabled.
- *
* MultipleOutputs supports counters, by default the are disabled. The counters
* group is the {@link AvroMultipleOutputs} class name.
- *
* The names of the counters are the same as the named outputs. For multi named
* outputs the name of the counter is the concatenation of the named output, and
* underscore '_' and the multiname.
@@ -320,12 +320,12 @@ public static void setCountersEnabled(JobConf conf, boolean enabled) {
/**
* Returns if the counters for the named outputs are enabled or not.
- *
* By default these counters are disabled.
- *
* MultipleOutputs supports counters, by default the are disabled. The counters
* group is the {@link AvroMultipleOutputs} class name.
- *
* The names of the counters are the same as the named outputs. For multi named
* outputs the name of the counter is the concatenation of the named output, and
* underscore '_' and the multiname.
@@ -422,7 +422,7 @@ public void close(Reporter reporter) throws IOException {
/**
* Output Collector for the default schema.
- *
*
* @param namedOutput the named output name
* @param reporter the reporter
@@ -435,7 +435,7 @@ public void collect(String namedOutput, Reporter reporter, Object datum) throws
/**
* OutputCollector with custom schema.
- *
*
* @param namedOutput the named output name (this will the output file name)
* @param reporter the reporter
@@ -449,7 +449,7 @@ public void collect(String namedOutput, Reporter reporter, Schema schema, Object
/**
* OutputCollector with custom schema and file name.
- *
*
* @param namedOutput the named output name
* @param reporter the reporter
@@ -465,7 +465,7 @@ public void collect(String namedOutput, Reporter reporter, Schema schema, Object
/**
* Gets the output collector for a named output.
- *
*
* @param namedOutput the named output name
* @param reporter the reporter
@@ -485,7 +485,7 @@ private AvroCollector getCollector(String namedOutput, Reporter reporter, Schema
/**
* Gets the output collector for a named output.
- *
*
* @param namedOutput the named output name
* @param reporter the reporter
@@ -500,7 +500,7 @@ public AvroCollector getCollector(String namedOutput, String multiName, Reporter
/**
* Gets the output collector for a multi named output.
- *
*
* @param namedOutput the named output name
* @param multiName the multi name part
@@ -543,7 +543,7 @@ public void collect(Object key) throws IOException {
/**
* Closes all the opened named outputs.
- *
* If overriden subclasses must invoke
* You can specify various options using Job Configuration properties. Look at
* the fields in {@link AvroJob} as well as this class to get an overview of the
* supported options.
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapred/DelegatingMapper.java b/lang/java/mapred/src/main/java/org/apache/avro/mapred/DelegatingMapper.java
index 47abf38c9ce..b1bcac1c96d 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapred/DelegatingMapper.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapred/DelegatingMapper.java
@@ -34,7 +34,8 @@
* map() call instead of during configure(), as we rely on the split object to
* provide us that information.
*
- * @see {@link AvroMultipleInputs#addInputPath(JobConf, Path, Class, Schema)}
+ * @see AvroMultipleInputs#addInputPath(org.apache.hadoop.mapred.JobConf,
+ * org.apache.hadoop.fs.Path, Class, org.apache.avro.Schema)
*/
class DelegatingMapper
*
*
* Suppose you would like to write a line count mapper that reads from a text
@@ -46,7 +46,7 @@
* the
*/
public final class AvroJob {
/** Disable the constructor for this utility class. */
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroKeyInputFormat.java b/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroKeyInputFormat.java
index 5323361d753..4f901bbdf86 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroKeyInputFormat.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroKeyInputFormat.java
@@ -37,7 +37,7 @@
* Keys are AvroKey wrapper objects that contain the Avro data. Since Avro
* container files store only records (not key/value pairs), the value from this
* InputFormat is a NullWritable.
- *
*/
public class AvroKeyInputFormat
* Since Avro container files only contain records (not key/value pairs), this
* output format ignores the value.
- *
*
* @param
*
* @param
*
*
* The keys and values given to this output format may be Avro objects wrapped
* in
*
* @param
* The contents of the 'key' field will be parsed into an AvroKey object. The
* contents of the 'value' field will be parsed into an AvroValue object.
- *
*
* @param
*
* @param
*
* Case two: to write data to different files provided by user
- *
*
*
* AvroMultipleOutputs supports counters, by default they are disabled. The
* counters group is the {@link AvroMultipleOutputs} class name. The names of
* the counters are the same as the output name. These count the number of
* records written to each output name.
- *
*
* Usage pattern for job submission:
*
@@ -216,7 +216,7 @@ private static List
*
* @param job job to add the named output
* @param namedOutput named output name, it has to be a word, letters and
@@ -233,7 +233,7 @@ public static void addNamedOutput(Job job, String namedOutput, Class extends O
/**
* Adds a named output for the job.
- *
*
* @param job job to add the named output
* @param namedOutput named output name, it has to be a word, letters and
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroRecordReaderBase.java b/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroRecordReaderBase.java
index 551216d50c1..69414447401 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroRecordReaderBase.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroRecordReaderBase.java
@@ -161,7 +161,7 @@ public void close() throws IOException {
*
*
* Calling
*
* @return The current Avro record (may be null if no record has been read).
*/
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroSequenceFileInputFormat.java b/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroSequenceFileInputFormat.java
index c10487ff9e3..cabee8d7de6 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroSequenceFileInputFormat.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroSequenceFileInputFormat.java
@@ -52,7 +52,7 @@ public RecordReader
* This class is based on Hadoop's SequenceFileRecordReader, modified to
* construct an AvroSequenceFile.Reader instead of a SequenceFile.Reader.
- *
*/
protected class AvroSequenceFileRecordReader extends RecordReader
*
*
* A subset schema to be read may be specified with
diff --git a/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyOutputFormat.java b/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyOutputFormat.java
index 8079b801090..15c2d24a7a9 100644
--- a/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyOutputFormat.java
+++ b/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyOutputFormat.java
@@ -39,7 +39,7 @@
*
* Since Trevni container files only contain records (not key/value pairs), this
* output format ignores the value.
- *
*
* @param
*
* @param
*
*
* The keys and values given to this output format may be Avro objects wrapped
* in
*
* @param
* The contents of the 'key' field will be parsed into an AvroKey object. The
* contents of the 'value' field will be parsed into an AvroValue object.
- *
*
* @param
*
* @param
* Calling
*
* @return The current Trevni record (may be null if no record has been read).
*/
diff --git a/pom.xml b/pom.xml
index 6693fc4cdfd..14ea4497ac8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -49,7 +49,7 @@
@@ -1333,11 +1333,11 @@ private UnionBuilder(Completion
@@ -1563,7 +1563,7 @@ public UnionFieldTypeBuilder
@@ -1580,7 +1580,7 @@ public BaseFieldTypeBuilder
@@ -1836,7 +1836,7 @@ public FieldBuilder
@@ -1850,7 +1850,7 @@ public FieldAssembler
@@ -1864,7 +1864,7 @@ public FieldAssembler
@@ -1877,7 +1877,7 @@ public FieldAssembler
@@ -1891,7 +1891,7 @@ public FieldAssembler
@@ -1905,7 +1905,7 @@ public FieldAssembler
@@ -1918,7 +1918,7 @@ public FieldAssembler
@@ -1932,7 +1932,7 @@ public FieldAssembler
@@ -1946,7 +1946,7 @@ public FieldAssembler
@@ -1959,7 +1959,7 @@ public FieldAssembler
@@ -1973,7 +1973,7 @@ public FieldAssembler
@@ -1987,7 +1987,7 @@ public FieldAssembler
@@ -2000,7 +2000,7 @@ public FieldAssembler
@@ -2014,7 +2014,7 @@ public FieldAssembler
@@ -2028,7 +2028,7 @@ public FieldAssembler
@@ -2041,7 +2041,7 @@ public FieldAssembler
@@ -2055,7 +2055,7 @@ public FieldAssembler
@@ -2069,7 +2069,7 @@ public FieldAssembler
@@ -2082,7 +2082,7 @@ public FieldAssembler
@@ -2096,7 +2096,7 @@ public FieldAssembler
@@ -2110,7 +2110,7 @@ public FieldAssembler
@@ -2216,12 +2216,12 @@ public GenericDefault
*
@@ -59,7 +59,7 @@
* {@link java.util.ServiceLoader}, which loads them using the context
* ClassLoader when available, or the application ClassLoader when not. See the
* {@code ServiceLoader} class for more detailsĪ.
- *
* new SchemaParser().parse(schema).mainSchema()
*
@@ -77,7 +77,7 @@ public static Schema parseSingle(String schema) throws SchemaParseException {
*
* new SchemaParser().parse(schemaFile).mainSchema()
*
@@ -104,11 +104,11 @@ public SchemaParser() {
* Create a schema parser with the specified name validator.
*
diff --git a/lang/java/avro/src/main/java/org/apache/avro/ValidateAll.java b/lang/java/avro/src/main/java/org/apache/avro/ValidateAll.java
index 9692dfe78be..0c5cbcf5dc6 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/ValidateAll.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/ValidateAll.java
@@ -22,12 +22,12 @@
*
- * Map
+ *
*
* @throws AvroTypeException If this is a stateful reader and map is not the
* type of the next value to be read
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/DecoderFactory.java b/lang/java/avro/src/main/java/org/apache/avro/io/DecoderFactory.java
index 1f9e05dad5e..fce1ac5b247 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/DecoderFactory.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/DecoderFactory.java
@@ -28,10 +28,10 @@
* Factories are thread-safe, and are generally cached by applications for
* performance reasons. Multiple instances are only required if multiple
* concurrent configurations are needed.
- *
+ * {@code
* out.writeMapStart();
* out.setItemCount(list.size());
* for (Map.Entry
*
* @throws AvroTypeException If this is a stateful writer and a map is not
diff --git a/lang/java/avro/src/main/java/org/apache/avro/io/EncoderFactory.java b/lang/java/avro/src/main/java/org/apache/avro/io/EncoderFactory.java
index eaa83ba8baa..368c02c5ac7 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/io/EncoderFactory.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/io/EncoderFactory.java
@@ -27,7 +27,7 @@
/**
* A factory for creating and configuring {@link Encoder} instances.
- *
+ * false, but this default can be overridden using the system
* property org.apache.avro.specific.use_custom_coders, and can be
- * set dynamically by {@link SpecificData#useCustomCoders()}. See Getting
* started with Java for more about this feature flag.
*/
public boolean useCustomCoders() {
diff --git a/lang/java/avro/src/main/java/org/apache/avro/util/TimePeriod.java b/lang/java/avro/src/main/java/org/apache/avro/util/TimePeriod.java
index 89496744f30..2e6922d0da3 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/util/TimePeriod.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/util/TimePeriod.java
@@ -42,18 +42,18 @@
*
*
diff --git a/lang/java/avro/src/main/java/org/apache/avro/util/UtfTextUtils.java b/lang/java/avro/src/main/java/org/apache/avro/util/UtfTextUtils.java
index 967a48bf364..bb534dd1b47 100644
--- a/lang/java/avro/src/main/java/org/apache/avro/util/UtfTextUtils.java
+++ b/lang/java/avro/src/main/java/org/apache/avro/util/UtfTextUtils.java
@@ -35,7 +35,7 @@
* is in the range U+0000-U+00FF. This heuristic works for all latin text based
* formats, which includes Avro IDL, JSON, XML, etc. If the heuristic fails,
* UTF-8 is assumed.
- *
+ * SequenceFile contains a header
* followed by a sequence of records. A record consists of a
* key and a value. The key and value must either:
- *
*
Writable interface, orCharSequence that also implements Writable should
* be serialized using Avro or WritableSerialization.
- * AvroSequenceFile is to:
- *
*
AvroKey object,Writer depending on
* the compression type, this method constructs the appropriate subclass
* depending on the compression type given in the options.
- *
+ * CharSequence interface, which does not define
* equals, hashCode, or compareTo.
- * String and
* Utf8 objects that are both valid when working with Avro strings.
- *
* // Enable ReflectData usage across job.
@@ -70,7 +70,7 @@
*
*
* Schema type1Schema = Type1Record.SCHEMA$;
@@ -97,14 +97,14 @@
*
Schema and OutputFormat. A named output can be a
* single file or a multi file. The later is refered as a multi named output
* which is an unbound set of files all sharing the same Schema.
- * super.close() at the end of
* their close()
*
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroOutputFormat.java b/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroOutputFormat.java
index 88ac1cd73fb..abefef9eccd 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroOutputFormat.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapred/AvroOutputFormat.java
@@ -50,7 +50,7 @@
/**
* An {@link org.apache.hadoop.mapred.OutputFormat} for Avro data files.
- * setMapOutputKeySchema() and
* setMapOutputValueSchema() methods to set writer schemas for the
* records you will generate.
- * AvroKey or AvroValue objects. The basic Writable
* types are also supported (e.g., IntWritable, Text); they will be converted to
* their corresponding Avro types.
- * AvroKey.
diff --git a/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroKeyValueRecordReader.java b/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroKeyValueRecordReader.java
index a6b7f7aaa3d..785e1e4ac9a 100644
--- a/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroKeyValueRecordReader.java
+++ b/lang/java/mapred/src/main/java/org/apache/avro/mapreduce/AvroKeyValueRecordReader.java
@@ -33,7 +33,7 @@
* Schema and OutputFormat.
- * nextKeyValue() moves this to the next record.
- * AvroKey or AvroValue objects. The basic Writable
* types are also supported (e.g., IntWritable, Text); they will be converted to
* their corresponding Avro types.
- * AvroKey.
diff --git a/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueRecordReader.java b/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueRecordReader.java
index 128fa3370d8..8f8f7af1585 100644
--- a/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueRecordReader.java
+++ b/lang/java/trevni/avro/src/main/java/org/apache/trevni/avro/mapreduce/AvroTrevniKeyValueRecordReader.java
@@ -32,7 +32,7 @@
* nextKeyValue() moves this to the next record.
- *