org.apache.avro.generic
Class GenericData

java.lang.Object
  org.apache.avro.generic.GenericData

Direct Known Subclasses:

SpecificData

public class GenericData
extends Object

Utilities for generic Java data.

Nested Class Summary

static class	GenericData.Array<T> Default implementation of an array.
static class	GenericData.EnumSymbol Default implementation of GenericEnumSymbol.
static class	GenericData.Fixed Default implementation of GenericFixed.
static class	GenericData.Record Default implementation of GenericRecord.

Constructor Summary

protected

GenericData()

Method Summary

int	compare(Object o1, Object o2, Schema s) Compare objects according to their schema.
protected int	compare(Object o1, Object o2, Schema s, boolean equals) Comparison implementation.
static GenericData	get() Return the singleton instance.
protected Schema	getEnumSchema(Object enu) Called to obtain the schema of a enum.
Object	getField(Object record, String name, int position) Called by GenericDatumReader.readRecord(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder) to retrieve a record field value from a reused instance.
protected Schema	getFixedSchema(Object fixed) Called to obtain the schema of a fixed.
protected Schema	getRecordSchema(Object record) Called to obtain the schema of a record.
int	hashCode(Object o, Schema s) Compute a hash code according to a schema, consistent with compare(Object,Object,Schema).
protected int	hashCodeAdd(int hashCode, Object o, Schema s) Add the hash code for an object into an accumulated hash code.
Schema	induce(Object datum) Create a schema given an example datum.
protected boolean	instanceOf(Schema schema, Object datum) Called by resolveUnion(Schema,Object).
protected boolean	isArray(Object datum) Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).
protected boolean	isBytes(Object datum) Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).
protected boolean	isEnum(Object datum) Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).
protected boolean	isFixed(Object datum) Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).
protected boolean	isMap(Object datum) Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).
protected boolean	isRecord(Object datum) Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).
protected boolean	isString(Object datum) Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).
int	resolveUnion(Schema union, Object datum) Return the index for a datum within a union.
void	setField(Object record, String name, int position, Object o) Called by GenericDatumReader.readRecord(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder) to set a record fields value to a record instance.
String	toString(Object datum) Renders a Java datum as JSON.
protected void	toString(Object datum, StringBuilder buffer) Renders a Java datum as JSON.
boolean	validate(Schema schema, Object datum) Returns true if a Java datum matches a schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericData

protected GenericData()

Method Detail

get

public static GenericData get()

Return the singleton instance.

validate

public boolean validate(Schema schema,
                        Object datum)

Returns true if a Java datum matches a schema.

toString

public String toString(Object datum)

Renders a Java datum as JSON.

toString

protected void toString(Object datum,
                        StringBuilder buffer)

Renders a Java datum as JSON.

induce

public Schema induce(Object datum)

Create a schema given an example datum.

setField

public void setField(Object record,
                     String name,
                     int position,
                     Object o)

Called by GenericDatumReader.readRecord(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder) to set a record fields value to a record instance. The default implementation is for IndexedRecord.

getField

public Object getField(Object record,
                       String name,
                       int position)

Called by GenericDatumReader.readRecord(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder) to retrieve a record field value from a reused instance. The default implementation is for IndexedRecord.

resolveUnion

public int resolveUnion(Schema union,
                        Object datum)

Return the index for a datum within a union. Implemented with instanceOf(Schema,Object).

instanceOf

protected boolean instanceOf(Schema schema,
                             Object datum)

Called by resolveUnion(Schema,Object). May be overridden for alternate data representations.

isArray

protected boolean isArray(Object datum)

Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).

isRecord

protected boolean isRecord(Object datum)

Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).

getRecordSchema

protected Schema getRecordSchema(Object record)

Called to obtain the schema of a record. By default calls {GenericContainer#getSchema(). May be overridden for alternate record representations.

isEnum

protected boolean isEnum(Object datum)

Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).

getEnumSchema

protected Schema getEnumSchema(Object enu)

Called to obtain the schema of a enum. By default calls {GenericContainer#getSchema(). May be overridden for alternate enum representations.

isMap

protected boolean isMap(Object datum)

Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).

isFixed

protected boolean isFixed(Object datum)

Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).

getFixedSchema

protected Schema getFixedSchema(Object fixed)

Called to obtain the schema of a fixed. By default calls {GenericContainer#getSchema(). May be overridden for alternate fixed representations.

isString

protected boolean isString(Object datum)

Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).

isBytes

protected boolean isBytes(Object datum)

Called by the default implementation of instanceOf(org.apache.avro.Schema, java.lang.Object).

hashCode

public int hashCode(Object o,
                    Schema s)

Compute a hash code according to a schema, consistent with compare(Object,Object,Schema).

hashCodeAdd

protected int hashCodeAdd(int hashCode,
                          Object o,
                          Schema s)

Add the hash code for an object into an accumulated hash code.

compare

public int compare(Object o1,
                   Object o2,
                   Schema s)

Compare objects according to their schema. If equal, return zero. If greater-than, return 1, if less than return -1. Order is consistent with that of BinaryData.compare(byte[], int, byte[], int, Schema).

compare

protected int compare(Object o1,
                      Object o2,
                      Schema s,
                      boolean equals)

Comparison implementation. When equals is true, only checks for equality, not for order.