# All Classes and Interfaces

Class
Description
ArrayPositionPredicate
Returns items by their position (numeric index) in an array
AvroAlias
Adds the given name and space as an alias to the schema.
AvroAliases
AvroDefault
Specifies a default value for a field as a JSON string.
AvroDoc
Sets the avrodoc for this java field.
AvroEncode
Expert: Fields with this annotation are encoded using the given custom encoder.
AvroGenerated
Indicates that an annotated class is an Avro generated class.
AvroIgnore
Marks a field as transient.
AvroMeta
Adds the given key:Value pair as metadata into the schema, at the corresponding node.
AvroMeta.AvroMetas
AvroMissingFieldException
Avro exception in case of missing fields.
AvroName
Sets the avroname for this java field.
AvroRemoteException
Base class for exceptions thrown to client by server.
AvroRuntimeException
Base Avro exception.
AvroSchema
Declares that a Java type should have a specified Avro schema, overriding the normally inferred schema.
AvroTypeException
Thrown when an illegal type is used.
BadHeaderException
Exception thrown by a `MessageDecoder` when a message header is not recognized.
BinaryData
Utilities for binary-encoded data.
BinaryDecoder
An `Decoder` for binary-format data.
BinaryEncoder
An abstract `Encoder` for Avro's binary encoding.
BinaryMessageDecoder<D>
A `MessageDecoder` that reads a binary-encoded datum.
BinaryMessageEncoder<D>
A `MessageEncoder` that adds a header and 8-byte schema fingerprint to each datum encoded as binary.
BlockingBinaryEncoder
A `BinaryEncoder` implementation that writes large arrays and maps as a sequence of blocks.
BlockingDirectBinaryEncoder
An `Encoder` for Avro's binary encoding that does not buffer output.
BufferedBinaryEncoder
An `Encoder` for Avro's binary encoding.
ByteBufferInputStream
Utility to present `ByteBuffer` data as an `InputStream`.
ByteBufferOutputStream
Utility to collect data written to an `OutputStream` in `ByteBuffer`s.
BZip2Codec
Implements bzip2 compression and decompression.
CanonicalSchemaFormatterFactory
Schema formatter factory that supports the "Parsing Canonical Form".
ClassUtils
Codec
Interface for Avro-supported compression codecs for data files.
CodecFactory
Encapsulates the ability to specify and configure a compression codec.
ConcurrentReferenceHashMap<K,V>
A `ConcurrentHashMap` that uses `soft` or weak references for both `keys` and `values`.
ConcurrentReferenceHashMap.Entry<K,V>
A single map entry.
ConcurrentReferenceHashMap.Reference<K,V>
A reference to an `ConcurrentReferenceHashMap.Entry` contained in the map.
ConcurrentReferenceHashMap.ReferenceType
Various reference types supported by this map.
ConcurrentReferenceHashMap.Restructure
The types of restructuring that can be performed.
Conversion<T>
Conversion between generic and logical type instances.
Conversions
Conversions.BigDecimalConversion
Conversions.DecimalConversion
Conversions.DurationConversion
Conversions.UUIDConversion
CustomEncoding<T>
Expert: a custom encoder and decoder that writes an object directly to avro.
DataFileConstants
Constants used in data files.
DataFileReader<D>
Random access to files written with `DataFileWriter`.
DataFileReader12<D>
Read files written by Avro version 1.2.
DataFileStream<D>
Streaming access to files written by `DataFileWriter`.
DataFileStream.Header
A handle that can be used to reopen a DataFile without re-reading the header of the stream.
DataFileWriter<D>
Stores in a file a sequence of data conforming to a schema.
DataFileWriter.AppendWriteException
Thrown by `DataFileWriter.append(Object)` when an exception occurs while writing a datum to the buffer.
DateAsLongEncoding
This encoder/decoder writes a java.util.Date object as a long to avro and reads a Date object from long.
DatumReader<D>
Read data of a schema.
DatumWriter<D>
Write data of a schema.
Decoder
Low-level support for de-serializing Avro values.
DecoderFactory
A factory for creating and configuring `Decoder`s.
DeflateCodec
Implements DEFLATE (RFC1951) compression and decompression.
DirectBinaryEncoder
An `Encoder` for Avro's binary encoding that does not buffer output.
Encoder
Low-level support for serializing Avro values.
EncoderFactory
A factory for creating and configuring `Encoder` instances.
ErrorBuilder<T>
Interface for error builders
FastReaderBuilder
FastReaderBuilder.ExecutionStep
FastReaderBuilder.FieldReader
FastReaderBuilder.MapReader
FastReaderBuilder.RecordReader
FastReaderBuilder.RecordReader.Stage
FastReaderBuilder.ReusingFieldReader
FileReader<D>
Interface for reading data from a file.
FixedSize
Declares the size of implementations of `GenericFixed`.
FormattedSchemaParser
Schema parser for a specific schema format.
GenericArray<T>
Array that permits reuse of contained elements.
GenericContainer
Contains data of other types.
GenericData
Utilities for generic Java data.
GenericData.AbstractArray<T>
GenericData.Array<T>
Default implementation of an array.
GenericData.EnumSymbol
Default implementation of `GenericEnumSymbol`.
GenericData.Fixed
Default implementation of `GenericFixed`.
GenericData.InstanceSupplier
GenericData.Record
Default implementation of `GenericRecord`.
GenericData.StringType
Used to specify the Java type for a string schema.
GenericDatumReader<D>
`DatumReader` for generic Java objects.
GenericDatumWriter<D>
`DatumWriter` for generic Java objects.
GenericEnumSymbol<E>
An enum symbol.
GenericFixed
Fixed-size data.
GenericRecord
A generic instance of a record schema.
GenericRecordBuilder
A RecordBuilder for generic records.
IndexedRecord
A record implementation that permits field access by integer index.
InvalidAvroMagicException
InvalidNumberEncodingException
Json
Utilities for reading and writing arbitrary Json data in Avro format.
Json.ObjectReader
`DatumReader` for arbitrary Json data using the object model described in `JsonProperties`.
Json.ObjectWriter
`DatumWriter` for arbitrary Json data using the object model described in `JsonProperties`.
JsonDecoder
A `Decoder` for Avro's JSON data encoding.
JsonEncoder
An `Encoder` for Avro's JSON data encoding.
JsonGrammarGenerator
The class that generates a grammar suitable to parse Avro data in JSON format.
JsonProperties
Base class for objects that have JSON-valued properties.
JsonProperties.Null
JsonSchemaFormatter
JsonSchemaFormatterFactory
JsonSchemaParser
Schema parser for JSON formatted schemata.
LocationStep
Selects items based on their "path" (name of a property under which they are stored) relative to the context.
LogicalType
Logical types provides an opt-in way to extend Avro's types.
LogicalTypes
LogicalTypes.BigDecimal
LogicalTypes.Date
Date represents a date without a time
LogicalTypes.Decimal
Decimal represents arbitrary-precision fixed-scale decimal numbers
LogicalTypes.Duration
Duration represents a duration, consisting on months, days and milliseconds
LogicalTypes.LocalTimestampMicros
LogicalTypes.LocalTimestampMillis
LogicalTypes.LocalTimestampNanos
LogicalTypes.LogicalTypeFactory
Factory interface and SPI for logical types.
LogicalTypes.TimeMicros
TimeMicros represents a time in microseconds without a date
LogicalTypes.TimeMillis
TimeMillis represents a time in milliseconds without a date
LogicalTypes.TimestampMicros
TimestampMicros represents a date and time in microseconds
LogicalTypes.TimestampMillis
TimestampMillis represents a date and time in milliseconds
LogicalTypes.TimestampNanos
TimestampNanos represents a date and time in nanoseconds
LogicalTypes.Uuid
Uuid represents a uuid without a time
MapEntry<K,V>
Deprecated.
Use org.apache.avro.util.MapEntry
MapEntry<K,V>
An implementation of `Map.Entry` with well-defined member names.
MapKeyPredicate
Returns items by their position (string key under which they are stored) in a map
MapUtil
MessageDecoder<D>
Deserializes a single datum from a ByteBuffer, byte array, or InputStream.
MessageDecoder.BaseDecoder<D>
Base class for `MessageEncoder` implementations that provides default implementations for most of the `DatumEncoder` API.
MessageEncoder<D>
Serializes an individual datum as a ByteBuffer or to an OutputStream.
MissingSchemaException
Exception thrown by a `MessageDecoder` when the message is encoded using an unknown `Schema`.
NameValidator
NameValidator.Result
NonCopyingByteArrayOutputStream
Utility to make data written to an `ByteArrayOutputStream` directly available as a `ByteBuffer`.
Nullable
Declares that null is a valid value for a Java type.
ParseContext
Class to define a name context, useful to reference schemata with.
Parser
Parser is the class that maintains the stack for parsing.
Parser.ActionHandler
The parser knows how to handle the terminal and non-terminal symbols.
ParsingDecoder
Base class for parser-based `Decoder`s.
ParsingEncoder
Base class for parser-based `Encoder`s.
PathElement
root interface for all pieces of an AvroPath expression
PathPredicate
a predicate is a filter that restricts items selected by a `LocationStep`
PathTracingException<T>
interface for exceptions that can trace the AvroPath of an error
PositionalPathPredicate
filters items by their context position
PrimitivesArrays
PrimitivesArrays.BooleanArray
PrimitivesArrays.DoubleArray
PrimitivesArrays.FloatArray
PrimitivesArrays.IntArray
PrimitivesArrays.LongArray
PrimitivesArrays.PrimitiveArray<T>
Protocol
A set of messages forming an application protocol.
RandomData
Generates schema data as Java objects with random values.
RawMessageDecoder<D>
A `MessageDecoder` that deserializes from raw datum bytes.
RawMessageEncoder<D>
A `MessageEncoder` that encodes only a datum's bytes, without additional information (such as a schema fingerprint).
RecordBuilder<T>
Interface for record builders
RecordBuilderBase<T>
Abstract base class for RecordBuilder implementations.
ReflectData
Utilities to use existing Java classes and interfaces via reflection.
ReflectData.AllowNull
`ReflectData` implementation that permits null field values.
ReflectDatumReader<T>
`DatumReader` for existing classes via Java reflection.
ReflectDatumWriter<T>
`DatumWriter` for existing classes via Java reflection.
ReflectionUtil
A few utility methods for using @link{java.misc.Unsafe}, mostly for private use.
Resolver
Encapsulate schema-resolution logic in an easy-to-consume representation.
Resolver.Action
An abstract class for an action to be taken to resolve a writer's schema (found in public instance variable `writer`) against a reader's schema (in `reader`).
Resolver.Action.Type
Helps us traverse faster.
Resolver.Container
Used for array and map schemas: the public instance variable `elementAction` contains the resolving action needed for the element type of an array or value top of a map.
Resolver.DoNothing
In this case, there's nothing to be done for resolution: the two schemas are effectively the same.
Resolver.EnumAdjust
Contains information needed to resolve enumerations.
Resolver.ErrorAction
In this case there is an error.
Resolver.ErrorAction.ErrorType
Resolver.Promote
In this case, the writer's type needs to be promoted to the reader's.
Resolver.ReaderUnion
In this case, the reader is a union and the writer is not.
Resolver.RecordAdjust
Instructions for resolving two record schemas.
Resolver.Skip
This only appears inside `Resolver.RecordAdjust.fieldActions`, i.e., the actions for adjusting the fields of a record.
Resolver.WriterUnion
In this case, the writer was a union.
ResolvingDecoder
`Decoder` that performs type-resolution between the reader's and writer's schemas.
ResolvingGrammarGenerator
The class that generates a resolving grammar to resolve between two schemas.
ReusableByteArrayInputStream
ReusableByteBufferInputStream
Schema
An abstract data type.
Schema.Field
A field within a record.
Schema.Field.Order
How values of this field should be ordered when sorting records.
Schema.Parser
A parser for JSON-format schemas.
Schema.SeenPair
Useful as key of `Map`s when traversing two schemas at the same time and need to watch for recursion.
Schema.Type
The type of schema.
SchemaBuilder
A fluent interface for building `Schema` instances.
SchemaBuilder.ArrayBuilder<R>
Builds an Avro Array type with optional properties.
SchemaBuilder.ArrayDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.BaseFieldTypeBuilder<R>
A special Builder for Record fields.
SchemaBuilder.BaseTypeBuilder<R>
A common API for building types within a context.
SchemaBuilder.BooleanBuilder<R>
Builds an Avro boolean type with optional properties.
SchemaBuilder.BooleanDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.BytesBuilder<R>
Builds an Avro bytes type with optional properties.
SchemaBuilder.BytesDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.DoubleBuilder<R>
Builds an Avro double type with optional properties.
SchemaBuilder.DoubleDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.EnumBuilder<R>
Builds an Avro Enum type with optional properties, namespace, doc, and aliases.
SchemaBuilder.EnumDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.FieldAssembler<R>
SchemaBuilder.FieldBuilder<R>
Builds a Field in the context of a `SchemaBuilder.FieldAssembler`.
SchemaBuilder.FieldDefault<R,S>
Abstract base class for field defaults.
SchemaBuilder.FieldTypeBuilder<R>
FieldTypeBuilder adds `SchemaBuilder.FieldTypeBuilder.unionOf()`, `SchemaBuilder.FieldTypeBuilder.nullable()`, and `SchemaBuilder.FieldTypeBuilder.optional()` to BaseFieldTypeBuilder.
SchemaBuilder.FixedBuilder<R>
Builds an Avro Fixed type with optional properties, namespace, doc, and aliases.
SchemaBuilder.FixedDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.FloatBuilder<R>
Builds an Avro float type with optional properties.
SchemaBuilder.FloatDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.GenericDefault<R>
SchemaBuilder.IntBuilder<R>
Builds an Avro int type with optional properties.
SchemaBuilder.IntDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.LongBuilder<R>
Builds an Avro long type with optional properties.
SchemaBuilder.LongDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.MapBuilder<R>
Builds an Avro Map type with optional properties.
SchemaBuilder.MapDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.NamedBuilder<S>
An abstract type that provides builder methods for configuring the name, doc, and aliases of all Avro types that have names (fields, Fixed, Record, and Enum).
SchemaBuilder.NamespacedBuilder<R,S>
An abstract type that provides builder methods for configuring the namespace for all Avro types that have namespaces (Fixed, Record, and Enum).
SchemaBuilder.NullBuilder<R>
Builds an Avro null type with optional properties.
SchemaBuilder.NullDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.PropBuilder<S>
An abstract builder for all Avro types.
SchemaBuilder.RecordBuilder<R>
SchemaBuilder.RecordDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.StringBldr<R>
Builds an Avro string type with optional properties.
SchemaBuilder.StringDefault<R>
Choose whether to use a default value for the field or not.
SchemaBuilder.TypeBuilder<R>
A Builder for creating any Avro schema type.
SchemaBuilder.UnionAccumulator<R>
Accumulates all of the types in a union.
SchemaBuilder.UnionFieldTypeBuilder<R>
Builder for a union field.
SchemaBuilderException
Thrown for errors building schemas.
SchemaCompatibility
Evaluate the compatibility between a reader schema and a writer schema.
SchemaCompatibility.Incompatibility
SchemaCompatibility.SchemaCompatibilityResult
Immutable class representing details about a particular schema pair compatibility check.
SchemaCompatibility.SchemaCompatibilityType
Identifies the type of a schema compatibility result.
SchemaCompatibility.SchemaIncompatibilityType
SchemaCompatibility.SchemaPairCompatibility
Provides information about the compatibility of a single reader and writer schema pair.
SchemaFormatter
Interface and factory to format schemas to text.
SchemaFormatterFactory
Service Provider Interface (SPI) for `SchemaFormatter`.
SchemaNormalization
Collection of static methods for generating the canonical form of schemas (see `SchemaNormalization.toParsingForm(org.apache.avro.Schema)`) -- and fingerprints of canonical forms (`SchemaNormalization.fingerprint(java.lang.String, byte[])`).
SchemaParseException
Thrown for errors parsing schemas and protocols.
SchemaParser
Avro schema parser for text-based formats like JSON, IDL, etc.
SchemaParser.ParseResult
SchemaResolver
Utility class to resolve schemas that are unavailable at the point they are referenced in a schema file.
SchemaResolver.IsResolvedSchemaVisitor
This visitor checks if the current schema is fully resolved.
SchemaResolver.ResolvingVisitor
This visitor creates clone of the visited Schemata, minus the specified schema properties, and resolves all unresolved schemas.
Schemas
Avro Schema utilities, to traverse...
SchemaStore
Interface for classes that can provide avro schemas by fingerprint.
SchemaStore.Cache
A map-based cache of schemas by AVRO-CRC-64 fingerprint.
SchemaUtil
SchemaValidationException
Thrown when `SchemaValidator` fails to validate a schema.
SchemaValidationStrategy
An interface for validating the compatibility of a single schema against another.
SchemaValidator
A SchemaValidator has one method, which validates that a `Schema` is compatible with the other schemas provided.
SchemaValidatorBuilder
A Builder for creating SchemaValidators.
SchemaVisitor<T>
SchemaVisitor.SchemaVisitorAction
SeekableByteArrayInput
A `SeekableInput` backed with data in a byte array.
SeekableFileInput
A `FileInputStream` that implements `SeekableInput`.
SeekableInput
An InputStream that supports seek and tell.
SkipParser
A parser that capable of skipping as well read and write.
SkipParser.SkipHandler
The clients implement this interface to skip symbols and actions.
SnappyCodec
Implements Snappy compression and decompression.
SpecificData
Utilities for generated Java classes and interfaces.
SpecificData.SchemaConstructable
Tag interface that indicates that a class has a one-argument constructor that accepts a Schema.
SpecificDatumReader<T>
`DatumReader` for generated Java classes.
SpecificDatumWriter<T>
`DatumWriter` for generated Java classes.
SpecificErrorBuilderBase<T>
Abstract base class for specific ErrorBuilder implementations.
SpecificExceptionBase
Base class for specific exceptions.
SpecificFixed
Base class for generated fixed-sized data classes.
SpecificRecord
Implemented by generated record classes.
SpecificRecordBase
Base class for generated record classes.
SpecificRecordBuilderBase<T>
Abstract base class for specific RecordBuilder implementations.
Stringable
Declares that a class or field should be represented by an Avro string.
Symbol
Symbol is the base of all symbols (terminals and non-terminals) of the grammar.
Symbol.Alternative
Symbol.DefaultStartAction
Symbol.EnumAdjustAction
Symbol.EnumLabelsAction
Symbol.ErrorAction
Symbol.FieldAdjustAction
Symbol.FieldOrderAction
Symbol.ImplicitAction
Symbol.IntCheckAction
Symbol.Kind
Symbol.Repeater
Symbol.ResolvingAction
Symbol.Root
Symbol.Sequence
Symbol.SkipAction
Symbol.UnionAdjustAction
Symbol.WriterUnionAction
Syncable
SyncableFileOutputStream
An implementation of Syncable which writes to a file.
SystemLimitException
Thrown to prevent making large allocations when reading potentially pathological input data from an untrusted source.
TimeConversions
TimeConversions.DateConversion
TimeConversions.LocalTimestampMicrosConversion
TimeConversions.LocalTimestampMillisConversion
TimeConversions.LocalTimestampNanosConversion
TimeConversions.TimeMicrosConversion
TimeConversions.TimeMillisConversion
TimeConversions.TimestampMicrosConversion
TimeConversions.TimestampMillisConversion
TimeConversions.TimestampNanosConversion
TimePeriod
A temporal amount to model an `Avro duration` (the logical type).
TracingAvroTypeException
an `AvroTypeException` with extra fields used to trace back the path to a bad value through an object graph
TracingClassCastException
a `ClassCastException` with extra fields used to trace back the path to a bad value through an object graph
TracingNullPointException
a `NullPointerException` with extra fields used to trace back the path to a null value through an object graph
Union
Declares that a Java type should be represented by an Avro union schema.
UnionTypePredicate
Returns items by their position (numeric index of type) in a union schema
UnknownAvroCodecException
UnresolvedUnionException
Thrown when the expected contents of a union cannot be resolved.
Utf8
A Utf8 string.
UtfTextUtils
Text utilities especially suited for UTF encoded bytes.
ValidateAll
A `SchemaValidator` for validating the provided schema against all schemas in the Iterable in `ValidateAll.validate(Schema, Iterable)`.
ValidateLatest
A `SchemaValidator` for validating the provided schema against the first `Schema` in the iterable in `ValidateLatest.validate(Schema, Iterable)`.
ValidatingDecoder
An implementation of `Decoder` that ensures that the sequence of operations conforms to a schema.
ValidatingEncoder
An implementation of `Encoder` that wraps another Encoder and ensures that the sequence of operations conforms to the provided schema.
ValidatingGrammarGenerator
The class that generates validating grammar.
WeakIdentityHashMap<K,V>
Implements a combination of WeakHashMap and IdentityHashMap.
XZCodec
Implements xz compression and decompression.
ZstandardCodec