org.apache.hudi.avro

Class JsonEncoder

java.lang.Object

org.apache.avro.io.Encoder

org.apache.avro.io.ParsingEncoder

org.apache.hudi.avro.JsonEncoder

All Implemented Interfaces:

Flushable, org.apache.avro.io.parsing.Parser.ActionHandler

public class JsonEncoder
extends org.apache.avro.io.ParsingEncoder
implements org.apache.avro.io.parsing.Parser.ActionHandler

An Encoder for Avro's JSON data encoding.

NOTE: This class is a copy of Avro's JsonEncoder class, with the only difference being that this class does not wrap union types in JSON by overriding writeIndex(int).

By default, Avro's JSON encoding for union types is to wrap the union value in a JSON object with the type name as the key (e.g., {"string": "value"}). This encoder overrides that behavior to write just the value, resulting in cleaner JSON output.

For instance, a union with schema ["null", "string"] would be encoded as just "value" instead of {"string": "value"}.

This encoder is particularly useful when the standard Avro JSON format's verbosity for union types is not desired.

Field Summary

Fields

Modifier and Type	Field and Description
protected BitSet	isEmpty Has anything been written into the collections?

Fields inherited from class org.apache.avro.io.ParsingEncoder

pos

Constructor Summary

Constructors

Constructor and Description
JsonEncoder(org.apache.avro.Schema sc, OutputStream out)

Method Summary

Modifier and Type	Method and Description
JsonEncoder	configure(OutputStream out) Reconfigures this JsonEncoder to use the output stream provided.
JsonEncoder	configure(OutputStream out, boolean autoflush) Reconfigures this JsonEncoder to use the output stream provided.
org.apache.avro.io.parsing.Symbol	doAction(org.apache.avro.io.parsing.Symbol input, org.apache.avro.io.parsing.Symbol top)
void	flush()
boolean	isIncludeNamespace()
void	setIncludeNamespace(boolean includeNamespace)
void	startItem()
void	writeArrayEnd()
void	writeArrayStart()
void	writeBoolean(boolean b)
void	writeBytes(byte[] bytes, int start, int len)
void	writeBytes(ByteBuffer bytes)
void	writeDouble(double d)
void	writeEnum(int e)
void	writeFixed(byte[] bytes, int start, int len)
void	writeFloat(float f)
void	writeIndex(int unionIndex)
void	writeInt(int n)
void	writeLong(long n)
void	writeMapEnd()
void	writeMapStart()
void	writeNull()
void	writeString(String str)
void	writeString(org.apache.avro.util.Utf8 utf8)

Methods inherited from class org.apache.avro.io.ParsingEncoder

depth, pop, push, setItemCount

Methods inherited from class org.apache.avro.io.Encoder

writeBytes, writeFixed, writeFixed, writeString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isEmpty

protected BitSet isEmpty

Has anything been written into the collections?

Constructor Detail

JsonEncoder

public JsonEncoder(org.apache.avro.Schema sc,
                   OutputStream out)
            throws IOException

Throws:

IOException

Method Detail

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

isIncludeNamespace

public boolean isIncludeNamespace()

setIncludeNamespace

public void setIncludeNamespace(boolean includeNamespace)

configure

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.

Parameters:

out - The OutputStream to direct output to. Cannot be null.

Returns:

this JsonEncoder

Throws:

IOException

NullPointerException - if out is null

configure

public JsonEncoder configure(OutputStream out,
                             boolean autoflush)
                      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.

Parameters:

out - The OutputStream to direct output to. Cannot be null.

Returns:

this JsonEncoder

Throws:

IOException

NullPointerException - if out is null

writeNull

public void writeNull()
               throws IOException

Specified by:

writeNull in class org.apache.avro.io.Encoder

Throws:

IOException

writeBoolean

public void writeBoolean(boolean b)
                  throws IOException

Specified by:

writeBoolean in class org.apache.avro.io.Encoder

Throws:

IOException

writeInt

public void writeInt(int n)
              throws IOException

Specified by:

writeInt in class org.apache.avro.io.Encoder

Throws:

IOException

writeLong

public void writeLong(long n)
               throws IOException

Specified by:

writeLong in class org.apache.avro.io.Encoder

Throws:

IOException

writeFloat

public void writeFloat(float f)
                throws IOException

Specified by:

writeFloat in class org.apache.avro.io.Encoder

Throws:

IOException

writeDouble

public void writeDouble(double d)
                 throws IOException

Specified by:

writeDouble in class org.apache.avro.io.Encoder

Throws:

IOException

writeString

public void writeString(org.apache.avro.util.Utf8 utf8)
                 throws IOException

Specified by:

writeString in class org.apache.avro.io.Encoder

Throws:

IOException

writeString

public void writeString(String str)
                 throws IOException

Overrides:

writeString in class org.apache.avro.io.Encoder

Throws:

IOException

writeBytes

public void writeBytes(ByteBuffer bytes)
                throws IOException

Specified by:

writeBytes in class org.apache.avro.io.Encoder

Throws:

IOException

writeBytes

public void writeBytes(byte[] bytes,
                       int start,
                       int len)
                throws IOException

Specified by:

writeBytes in class org.apache.avro.io.Encoder

Throws:

IOException

writeFixed

public void writeFixed(byte[] bytes,
                       int start,
                       int len)
                throws IOException

Specified by:

writeFixed in class org.apache.avro.io.Encoder

Throws:

IOException

writeEnum

public void writeEnum(int e)
               throws IOException

Specified by:

writeEnum in class org.apache.avro.io.Encoder

Throws:

IOException

writeArrayStart

public void writeArrayStart()
                     throws IOException

Specified by:

writeArrayStart in class org.apache.avro.io.Encoder

Throws:

IOException

writeArrayEnd

public void writeArrayEnd()
                   throws IOException

Specified by:

writeArrayEnd in class org.apache.avro.io.Encoder

Throws:

IOException

writeMapStart

public void writeMapStart()
                   throws IOException

Specified by:

writeMapStart in class org.apache.avro.io.Encoder

Throws:

IOException

writeMapEnd

public void writeMapEnd()
                 throws IOException

Specified by:

writeMapEnd in class org.apache.avro.io.Encoder

Throws:

IOException

startItem

public void startItem()
               throws IOException

Overrides:

startItem in class org.apache.avro.io.ParsingEncoder

Throws:

IOException

writeIndex

public void writeIndex(int unionIndex)
                throws IOException

Specified by:

writeIndex in class org.apache.avro.io.Encoder

Throws:

IOException

doAction

public org.apache.avro.io.parsing.Symbol doAction(org.apache.avro.io.parsing.Symbol input,
                                                  org.apache.avro.io.parsing.Symbol top)
                                           throws IOException

Specified by:

doAction in interface org.apache.avro.io.parsing.Parser.ActionHandler

Throws:

IOException