Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	SpecificData.SchemaConstructable Tag interface that indicates that a class has a one-argument constructor that accepts a Schema.

Field Summary

Modifier and Type	Field and Description
public static final String	CLASS_PROP
private final ConcurrentMap<String, Class<T>>	classCache
private static final Function<Class<?>, Constructor<?>>	CTOR_CACHE
public static final String	ELEMENT_PROP
private static final SpecificData	INSTANCE Hides org.apache.avro.generic.GenericData.INSTANCE.
public static final String	KEY_CLASS_PROP
private static final Function<Class<?>, SpecificData>	MODEL_CACHE
private static final Class<?>[]	NO_ARG
private static final Class<T>	NO_CLASS
private static final Schema	NULL_SCHEMA
public static final char	RESERVED_WORD_ESCAPE_CHAR
public static final Set<String>	RESERVED_WORDS Reserved words from https://docs.oracle.com/javase/specs/jls/se16/html/jls-3.html require mangling in order to be used in generated Java code.
private static final Class<?>[]	SCHEMA_ARG
private final ClassValueCache<Schema>	schemaClassCache
private final Map<Type, Schema>	schemaTypeCache
protected Set<Class<T>>	stringableClasses Read/write some common builtin classes as strings.
private boolean	useCustomCoderFlag

Inherited from org.apache.avro.generic.GenericData:: FAST_READER_PROP STRING_PROP STRING_TYPE_STRING

Constructor Summary

Access	Constructor and Description
public	SpecificData() For subclasses.
public	SpecificData(ClassLoader classLoader) Construct with a specific classloader.

Method Summary

Modifier and Type	Method and Description
protected int	compare(Object o1, Object o2, Schema s, boolean eq) Overrides org.apache.avro.generic.GenericData.compare. Comparison implementation.
public DatumReader<D>	createDatumReader(Schema schema) Overrides org.apache.avro.generic.GenericData.createDatumReader. Returns a `DatumReader` for this kind of data.
public DatumReader<D>	createDatumReader(Schema writer, Schema reader) Overrides org.apache.avro.generic.GenericData.createDatumReader. Returns a `DatumReader` for this kind of data.
public DatumWriter<D>	createDatumWriter(Schema schema) Overrides org.apache.avro.generic.GenericData.createDatumWriter. Returns a `DatumWriter` for this kind of data.
public Object	createEnum(String symbol, Schema schema) Overrides org.apache.avro.generic.GenericData.createEnum. Called to create an enum value.
public Object	createFixed(Object old, Schema schema) Overrides org.apache.avro.generic.GenericData.createFixed. Called to create an fixed value.
protected Schema	createSchema(Type type, Map<String, Schema> names) Create the schema for a Java type.
public Object	createString(Object value) Overrides org.apache.avro.generic.GenericData.createString. Called to create an string value.
public static SpecificData	get() Hides org.apache.avro.generic.GenericData.get. Return the singleton instance.
public Class<T>	getClass(Schema schema) Return the class that implements a schema, or null if none exists.
public static String	getClassName(Schema schema) Returns the Java class name indicated by a schema's name and namespace.
public static BinaryDecoder	getDecoder(ObjectInput in) Runtime utility used by generated classes.
public static BinaryEncoder	getEncoder(ObjectOutput out) Runtime utility used by generated classes.
protected Schema	getEnumSchema(Object datum) Overrides org.apache.avro.generic.GenericData.getEnumSchema. Called to obtain the schema of a enum.
public static < . T> SpecificData	Returns: The SpecificData from the SpecificRecordBase instance, or the default SpecificData instance. getForClass(Class<T> A class c) If the given class is assignable to `SpecificRecordBase`, this method returns the SpecificData instance from the field `MODEL$`, in order to get the correct `org.apache.avro.Conversion` instances for the class.
public static SpecificData	Returns: the SpecificData associated with the schema's class, or the default instance. getForSchema(Schema the reader schema reader) For RECORD and UNION type schemas, this method returns the SpecificData instance of the class associated with the schema, in order to get the right conversions for any logical types used.
public GenericData.InstanceSupplier	getNewRecordSupplier(Schema schema) Overrides org.apache.avro.generic.GenericData.getNewRecordSupplier. create a supplier that allows to get new record instances for a given schema in an optimized way
public Protocol	getProtocol(Class<T> iface) Return the protocol for a Java interface.
public Schema	getSchema(Type type) Find the schema for a Java type.
protected String	getSchemaName(Object datum) Overrides org.apache.avro.generic.GenericData.getSchemaName. Return the schema full name for a datum.
private Class<T>	getWrapper(Schema schema)
protected boolean	isEnum(Object datum) Overrides org.apache.avro.generic.GenericData.isEnum. Called by the default implementation of `instanceOf`.
protected boolean	isStringable(Class<?> c) True if a class should be serialized with toString().
protected boolean	isStringType(Class<?> c) True if a class IS a string type
public static Object	newInstance(Class<T> c, Schema s) Create an instance of a class.
public Object	newRecord(Object old, Schema schema) Overrides org.apache.avro.generic.GenericData.newRecord. Called to create new record instances.
public void	setCustomCoders(boolean flag) Dynamically set the value of the custom-coder feature flag.
protected static String	unmangle(String word) Undoes mangling for reserved words.
public boolean	useCustomCoders() Retrieve the current value of the custom-coders feature flag.

Field Detail

CLASS_PROP	back to summary
public static final String CLASS_PROP

classCache	back to summary
private final ConcurrentMap<String, Class<T>> classCache

CTOR_CACHE	back to summary
private static final Function<Class<?>, Constructor<?>> CTOR_CACHE

ELEMENT_PROP	back to summary
public static final String ELEMENT_PROP

INSTANCE	back to summary
private static final SpecificData INSTANCE Hides org.apache.avro.generic.GenericData.INSTANCE.

KEY_CLASS_PROP	back to summary
public static final String KEY_CLASS_PROP

MODEL_CACHE	back to summary
private static final Function<Class<?>, SpecificData> MODEL_CACHE

NO_ARG	back to summary
private static final Class<?>[] NO_ARG

NO_CLASS	back to summary
private static final Class<T> NO_CLASS

NULL_SCHEMA	back to summary
private static final Schema NULL_SCHEMA

RESERVED_WORD_ESCAPE_CHAR	back to summary
public static final char RESERVED_WORD_ESCAPE_CHAR

RESERVED_WORDS	back to summary
public static final Set<String> RESERVED_WORDS Reserved words from https://docs.oracle.com/javase/specs/jls/se16/html/jls-3.html require mangling in order to be used in generated Java code.

SCHEMA_ARG	back to summary
private static final Class<?>[] SCHEMA_ARG

schemaClassCache	back to summary
private final ClassValueCache<Schema> schemaClassCache

schemaTypeCache	back to summary
private final Map<Type, Schema> schemaTypeCache

stringableClasses	back to summary
protected Set<Class<T>> stringableClasses Read/write some common builtin classes as strings. Representing these as strings isn't always best, as they aren't always ordered ideally, but at least they're stored. Also note that, for compatibility, only classes that wouldn't be otherwise correctly readable or writable should be added here, e.g., those without a no-arg constructor or those whose fields are all transient.

stringableClasses

back to summary

protected Set<Class<T>> stringableClasses

Read/write some common builtin classes as strings. Representing these as strings isn't always best, as they aren't always ordered ideally, but at least they're stored. Also note that, for compatibility, only classes that wouldn't be otherwise correctly readable or writable should be added here, e.g., those without a no-arg constructor or those whose fields are all transient.

useCustomCoderFlag	back to summary
private boolean useCustomCoderFlag

Constructor Detail

SpecificData	back to summary
public SpecificData() For subclasses. Applications normally use `SpecificData#get()`.

SpecificData	back to summary
public SpecificData(ClassLoader classLoader) Construct with a specific classloader.

Method Detail

compare	back to summary
protected int compare(Object o1, Object o2, Schema s, boolean eq) Overrides org.apache.avro.generic.GenericData.compare. Doc from org.apache.avro.generic.GenericData.compare. Comparison implementation. When equals is true, only checks for equality, not for order. Annotations @Override

compare

back to summary

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

Overrides org.apache.avro.generic.GenericData.compare.

Doc from org.apache.avro.generic.GenericData.compare.

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

Annotations

@Override

createDatumReader back to summary

createDatumReader	back to summary
public DatumReader<D> createDatumReader(Schema schema) Overrides org.apache.avro.generic.GenericData.createDatumReader. Doc from org.apache.avro.generic.GenericData.createDatumReader. Returns a `DatumReader` for this kind of data. Annotations @Override

public DatumReader<D> createDatumReader(Schema schema)

Overrides org.apache.avro.generic.GenericData.createDatumReader.

Doc from org.apache.avro.generic.GenericData.createDatumReader.

Returns a DatumReader for this kind of data.

Annotations

@Override

createDatumReader back to summary

createDatumReader	back to summary
public DatumReader<D> createDatumReader(Schema writer, Schema reader) Overrides org.apache.avro.generic.GenericData.createDatumReader. Doc from org.apache.avro.generic.GenericData.createDatumReader. Returns a `DatumReader` for this kind of data. Annotations @Override

public DatumReader<D> createDatumReader(Schema writer, Schema reader)

Overrides org.apache.avro.generic.GenericData.createDatumReader.

Doc from org.apache.avro.generic.GenericData.createDatumReader.

Returns a DatumReader for this kind of data.

Annotations

@Override

createDatumWriter back to summary

createDatumWriter	back to summary
public DatumWriter<D> createDatumWriter(Schema schema) Overrides org.apache.avro.generic.GenericData.createDatumWriter. Doc from org.apache.avro.generic.GenericData.createDatumWriter. Returns a `DatumWriter` for this kind of data. Annotations @Override

public DatumWriter<D> createDatumWriter(Schema schema)

Overrides org.apache.avro.generic.GenericData.createDatumWriter.

Doc from org.apache.avro.generic.GenericData.createDatumWriter.

Returns a DatumWriter for this kind of data.

Annotations

@Override

createEnum	back to summary
public Object createEnum(String symbol, Schema schema) Overrides org.apache.avro.generic.GenericData.createEnum. Doc from org.apache.avro.generic.GenericData.createEnum. Called to create an enum value. May be overridden for alternate enum representations. By default, returns a GenericEnumSymbol. Annotations @Override

createEnum

back to summary

public Object createEnum(String symbol, Schema schema)

Overrides org.apache.avro.generic.GenericData.createEnum.

Doc from org.apache.avro.generic.GenericData.createEnum.

Called to create an enum value. May be overridden for alternate enum representations. By default, returns a GenericEnumSymbol.

Annotations

@Override

createFixed back to summary

createFixed	back to summary
public Object createFixed(Object old, Schema schema) Overrides org.apache.avro.generic.GenericData.createFixed. Doc from org.apache.avro.generic.GenericData.createFixed. Called to create an fixed value. May be overridden for alternate fixed representations. By default, returns `GenericFixed`. Annotations @Override

public Object createFixed(Object old, Schema schema)

Overrides org.apache.avro.generic.GenericData.createFixed.

Doc from org.apache.avro.generic.GenericData.createFixed.

Called to create an fixed value. May be overridden for alternate fixed representations. By default, returns GenericFixed.

Annotations

@Override

createSchema	back to summary
protected Schema createSchema(Type type, Map<String, Schema> names) Create the schema for a Java type. Annotations @SuppressWarnings:unchecked

createSchema

back to summary

protected Schema createSchema(Type type, Map<String, Schema> names)

Create the schema for a Java type.

Annotations

@SuppressWarnings:unchecked

createString	back to summary
public Object createString(Object value) Overrides org.apache.avro.generic.GenericData.createString. Doc from org.apache.avro.generic.GenericData.createString. Called to create an string value. May be overridden for alternate string representations. Annotations @Override

createString

back to summary

public Object createString(Object value)

Overrides org.apache.avro.generic.GenericData.createString.

Doc from org.apache.avro.generic.GenericData.createString.

Called to create an string value. May be overridden for alternate string representations.

Annotations

@Override

get	back to summary
public static SpecificData get() Hides org.apache.avro.generic.GenericData.get. Return the singleton instance.

get

back to summary

public static SpecificData get()

Hides org.apache.avro.generic.GenericData.get.

Return the singleton instance.

getClass	back to summary
public Class<T> getClass(Schema schema) Return the class that implements a schema, or null if none exists.

getClassName	back to summary
public static String getClassName(Schema schema) Returns the Java class name indicated by a schema's name and namespace.

getDecoder	back to summary
public static BinaryDecoder getDecoder(ObjectInput in) Runtime utility used by generated classes.

getEncoder	back to summary
public static BinaryEncoder getEncoder(ObjectOutput out) Runtime utility used by generated classes.

getEnumSchema	back to summary
protected Schema getEnumSchema(Object datum) Overrides org.apache.avro.generic.GenericData.getEnumSchema. Doc from org.apache.avro.generic.GenericData.getEnumSchema. Called to obtain the schema of a enum. By default calls {GenericContainer#getSchema(). May be overridden for alternate enum representations. Annotations @Override

getEnumSchema

back to summary

protected Schema getEnumSchema(Object datum)

Overrides org.apache.avro.generic.GenericData.getEnumSchema.

Doc from org.apache.avro.generic.GenericData.getEnumSchema.

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

Annotations

@Override

getForClass back to summary

getForClass	back to summary
public static <T> SpecificData getForClass(Class<T> c) If the given class is assignable to `SpecificRecordBase`, this method returns the SpecificData instance from the field `MODEL$`, in order to get the correct `org.apache.avro.Conversion` instances for the class. Falls back to the default instance `SpecificData#get()` for other classes or if the field is not found. Parameters <T> . c:Class<T> A class Returns:SpecificData The SpecificData from the SpecificRecordBase instance, or the default SpecificData instance.

public static <T> SpecificData getForClass(Class<T> c)

If the given class is assignable to SpecificRecordBase, this method returns the SpecificData instance from the field MODEL$, in order to get the correct org.apache.avro.Conversion instances for the class. Falls back to the default instance SpecificData#get() for other classes or if the field is not found.

Parameters

<T>: .
c:Class<T>: A class

Returns:SpecificData

The SpecificData from the SpecificRecordBase instance, or the default SpecificData instance.

getForSchema	back to summary
public static SpecificData getForSchema(Schema reader) For RECORD and UNION type schemas, this method returns the SpecificData instance of the class associated with the schema, in order to get the right conversions for any logical types used. Parameters reader:Schema the reader schema Returns:SpecificData the SpecificData associated with the schema's class, or the default instance.

getForSchema

back to summary

public static SpecificData getForSchema(Schema reader)

For RECORD and UNION type schemas, this method returns the SpecificData instance of the class associated with the schema, in order to get the right conversions for any logical types used.

Parameters

reader:Schema: the reader schema

Returns:SpecificData

the SpecificData associated with the schema's class, or the default instance.

getNewRecordSupplier	back to summary
public GenericData.InstanceSupplier getNewRecordSupplier(Schema schema) Overrides org.apache.avro.generic.GenericData.getNewRecordSupplier. Doc from org.apache.avro.generic.GenericData.getNewRecordSupplier. create a supplier that allows to get new record instances for a given schema in an optimized way Annotations @SuppressWarnings:rawtypes @Override

getNewRecordSupplier

back to summary

public GenericData.InstanceSupplier getNewRecordSupplier(Schema schema)

Overrides org.apache.avro.generic.GenericData.getNewRecordSupplier.

Doc from org.apache.avro.generic.GenericData.getNewRecordSupplier.

create a supplier that allows to get new record instances for a given schema in an optimized way

Annotations

@SuppressWarnings:rawtypes
@Override

getProtocol	back to summary
public Protocol getProtocol(Class<T> iface) Return the protocol for a Java interface.

getSchema	back to summary
public Schema getSchema(Type type) Find the schema for a Java type.

getSchemaName back to summary

getSchemaName	back to summary
protected String getSchemaName(Object datum) Overrides org.apache.avro.generic.GenericData.getSchemaName. Doc from org.apache.avro.generic.GenericData.getSchemaName. Return the schema full name for a datum. Called by `resolveUnion(Schema, Object)`. Annotations @Override

protected String getSchemaName(Object datum)

Overrides org.apache.avro.generic.GenericData.getSchemaName.

Doc from org.apache.avro.generic.GenericData.getSchemaName.

Return the schema full name for a datum. Called by resolveUnion(Schema, Object).

Annotations

@Override

getWrapper	back to summary
private Class<T> getWrapper(Schema schema)

isEnum back to summary

isEnum	back to summary
protected boolean isEnum(Object datum) Overrides org.apache.avro.generic.GenericData.isEnum. Doc from org.apache.avro.generic.GenericData.isEnum. Called by the default implementation of `instanceOf`. Annotations @Override

protected boolean isEnum(Object datum)

Overrides org.apache.avro.generic.GenericData.isEnum.

Doc from org.apache.avro.generic.GenericData.isEnum.

Called by the default implementation of instanceOf.

Annotations

@Override

isStringable	back to summary
protected boolean isStringable(Class<?> c) True if a class should be serialized with toString().

isStringType	back to summary
protected boolean isStringType(Class<?> c) True if a class IS a string type

newInstance back to summary

newInstance	back to summary
public static Object newInstance(Class<T> c, Schema s) Create an instance of a class. If the class implements `SchemaConstructable`, call a constructor with a `org.apache.avro.Schema` parameter, otherwise use a no-arg constructor. Annotations @SuppressWarnings:unchecked

public static Object newInstance(Class<T> c, Schema s)

Create an instance of a class. If the class implements SchemaConstructable, call a constructor with a org.apache.avro.Schema parameter, otherwise use a no-arg constructor.

Annotations

@SuppressWarnings:unchecked

newRecord back to summary

newRecord	back to summary
public Object newRecord(Object old, Schema schema) Overrides org.apache.avro.generic.GenericData.newRecord. Doc from org.apache.avro.generic.GenericData.newRecord. Called to create new record instances. Subclasses may override to use a different record implementation. The returned instance must conform to the schema provided. If the old object contains fields not present in the schema, they should either be removed from the old object, or it should create a new instance that conforms to the schema. By default, this returns a `GenericData.Record`. Annotations @Override

public Object newRecord(Object old, Schema schema)

Overrides org.apache.avro.generic.GenericData.newRecord.

Doc from org.apache.avro.generic.GenericData.newRecord.

Called to create new record instances. Subclasses may override to use a different record implementation. The returned instance must conform to the schema provided. If the old object contains fields not present in the schema, they should either be removed from the old object, or it should create a new instance that conforms to the schema. By default, this returns a GenericData.Record.

Annotations

@Override

setCustomCoders	back to summary
public void setCustomCoders(boolean flag) Dynamically set the value of the custom-coder feature flag. See `SpecificData#useCustomCoders()`.

unmangle	back to summary
protected static String unmangle(String word) Undoes mangling for reserved words.

useCustomCoders	back to summary
public boolean useCustomCoders() Retrieve the current value of the custom-coders feature flag. Defaults to `false`, but this default can be overridden using the system property `org.apache.avro.specific.use_custom_coders`, and can be set dynamically by `SpecificData#useCustomCoders()`. See for more about this feature flag.

org.apache.avro.specific back to summary

public Interface SpecificData.SchemaConstructable

Tag interface that indicates that a class has a one-argument constructor that accepts a Schema.

See Also: newInstance

public Class SpecificData

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface SpecificData.SchemaConstructable