Top Description Inners Fields Constructors Methods
org.apache.avro.data

public Class Json

extends Object
Class Inheritance
Imports
java.io.IOException, .InputStream, java.util.Iterator, org.apache.avro.util.internal.JacksonUtils, com.fasterxml.jackson.core.JsonFactory, com.fasterxml.jackson.databind.JsonNode, .ObjectMapper, com.fasterxml.jackson.databind.node.JsonNodeFactory, .LongNode, .DoubleNode, .TextNode, .BooleanNode, .NullNode, .ArrayNode, .ObjectNode, org.apache.avro.Schema, .AvroRuntimeException, org.apache.avro.io.DatumReader, .DatumWriter, .Encoder, .Decoder, .DecoderFactory, .ResolvingDecoder

Utilities for reading and writing arbitrary Json data in Avro format.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static enum
Json.JsonType

Note

this enum must be kept aligned with the union in Json.avsc.

public static class
Json.ObjectReader

DatumReader for arbitrary Json data using the object model described in org.apache.avro.JsonProperties.

public static class
Json.ObjectWriter

DatumWriter for arbitrary Json data using the object model described in org.apache.avro.JsonProperties.

Field Summary

Modifier and TypeField and Description
pack-priv static final JsonFactory
pack-priv static final ObjectMapper
public static final Schema
SCHEMA

The schema for Json data.

Constructor Summary

AccessConstructor and Description
private
Json()

Method Summary

Modifier and TypeMethod and Description
public static Object
parseJson(String s)

Parses a JSON string and converts it to the object model described in org.apache.avro.JsonProperties.

private static JsonNode
read(Decoder in)

Read Json data from Avro data.

private static Object
public static String
toString(Object datum)

Converts an instance of the object model described in org.apache.avro.JsonProperties to a JSON string.

private static void
write(JsonNode node, Encoder out)

Write Json data as Avro data.

private static void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

FACTORYback to summary
pack-priv static final JsonFactory FACTORY
MAPPERback to summary
pack-priv static final ObjectMapper MAPPER
SCHEMAback to summary
public static final Schema SCHEMA

The schema for Json data.

Constructor Detail

Jsonback to summary
private Json()

Method Detail

parseJsonback to summary
public static Object parseJson(String s)

Parses a JSON string and converts it to the object model described in org.apache.avro.JsonProperties.

readback to summary
private static JsonNode read(Decoder in) throws IOException

Read Json data from Avro data.

readObjectback to summary
private static Object readObject(Decoder in) throws IOException
toStringback to summary
public static String toString(Object datum)

Converts an instance of the object model described in org.apache.avro.JsonProperties to a JSON string.

writeback to summary
private static void write(JsonNode node, Encoder out) throws IOException

Write Json data as Avro data.

writeObjectback to summary
private static void writeObject(Object datum, Encoder out) throws IOException
org.apache.avro.data back to summary

private final Enum Json.JsonType

extends Enum<Json.JsonType>
Class Inheritance

Note

this enum must be kept aligned with the union in Json.avsc.

Field Summary

Modifier and TypeField and Description
public static final Json.JsonType
public static final Json.JsonType
public static final Json.JsonType
public static final Json.JsonType
public static final Json.JsonType
public static final Json.JsonType
public static final Json.JsonType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static Json.JsonType
public static Json.JsonType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ARRAYback to summary
public static final Json.JsonType ARRAY
BOOLEANback to summary
public static final Json.JsonType BOOLEAN
DOUBLEback to summary
public static final Json.JsonType DOUBLE
LONGback to summary
public static final Json.JsonType LONG
NULLback to summary
public static final Json.JsonType NULL
OBJECTback to summary
public static final Json.JsonType OBJECT
STRINGback to summary
public static final Json.JsonType STRING

Constructor Detail

JsonTypeback to summary
private JsonType()

Method Detail

valueOfback to summary
public static Json.JsonType valueOf(String name)
valuesback to summary
public static Json.JsonType[] values()
org.apache.avro.data back to summary

public Class Json.ObjectReader

extends Object
implements DatumReader<Object>
Class Inheritance
All Implemented Interfaces
org.apache.avro.io.DatumReader

DatumReader for arbitrary Json data using the object model described in org.apache.avro.JsonProperties.

Field Summary

Modifier and TypeField and Description
private ResolvingDecoder
private Schema

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Object
read(Object reuse, Decoder in)

Implements org.apache.avro.io.DatumReader.read.

Read a datum.
public void
setSchema(Schema schema)

Implements org.apache.avro.io.DatumReader.setSchema.

Set the writer's schema.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

resolverback to summary
private ResolvingDecoder resolver
writtenback to summary
private Schema written

Constructor Detail

ObjectReaderback to summary
public ObjectReader()

Method Detail

readback to summary
public Object read(Object reuse, Decoder in) throws IOException

Implements org.apache.avro.io.DatumReader.read.

Doc from org.apache.avro.io.DatumReader.read.

Read a datum. Traverse the schema, depth-first, reading all leaf values in the schema into a datum that is returned. If the provided datum is non-null it may be reused and returned.

Annotations
@Override
setSchemaback to summary
public void setSchema(Schema schema)

Implements org.apache.avro.io.DatumReader.setSchema.

Doc from org.apache.avro.io.DatumReader.setSchema.

Set the writer's schema.

Annotations
@Override
org.apache.avro.data back to summary

public Class Json.ObjectWriter

extends Object
implements DatumWriter<Object>
Class Inheritance
All Implemented Interfaces
org.apache.avro.io.DatumWriter

DatumWriter for arbitrary Json data using the object model described in org.apache.avro.JsonProperties.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
setSchema(Schema schema)

Implements org.apache.avro.io.DatumWriter.setSchema.

Set the schema.
public void
write(Object datum, Encoder out)

Implements org.apache.avro.io.DatumWriter.write.

Write a datum.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ObjectWriterback to summary
public ObjectWriter()

Method Detail

setSchemaback to summary
public void setSchema(Schema schema)

Implements org.apache.avro.io.DatumWriter.setSchema.

Doc from org.apache.avro.io.DatumWriter.setSchema.

Set the schema.

Annotations
@Override
writeback to summary
public void write(Object datum, Encoder out) throws IOException

Implements org.apache.avro.io.DatumWriter.write.

Doc from org.apache.avro.io.DatumWriter.write.

Write a datum. Traverse the schema, depth first, writing each leaf value in the schema from the datum to the output.

Annotations
@Override