Top Description Interfaces Classes
[default module]

Package org.apache.avro


Avro kernel classes.

A org.apache.avro.Schema provides an abstract definition of a data type.

The in-memory representation of data is determined by org.apache.avro.io.DatumReader and org.apache.avro.io.DatumWriter implementations. Generic implementations are provided in the org.apache.avro.generic package. A href="../../../org/apache/avro/compiler/specific/SpecificCompiler.html" title="class in org.apache.avro.compiler.specific"> <code>compiler</code></a> can generate specific java classes and interfaces for schemas and protocols. Schemas may be automatically generated for existing Java classes by reflection using the org.apache.avro.reflect package.

Data of a given schema is always serialized identically, regardless of its in-memory representation, by traversing the schema and writing leaf values from the data structure with a org.apache.avro.io.Encoder. Deserializing similarly proceeds by traversing the schema, reading leaf values with a org.apache.avro.io.Decoder and storing them in an in-memory data structure.

Interface Summary

Modifier and TypeInterface and Description
public interface
SchemaValidationStrategy

An interface for validating the compatibility of a single schema against another.

public interface
SchemaValidator

A SchemaValidator has one method, which validates that a Schema is compatible with the other schemas provided.

Class Summary

Modifier and TypeClass and Description
public class
AvroMissingFieldException

Avro exception in case of missing fields.

public class
AvroRemoteException

Base class for exceptions thrown to client by server.

public class
AvroRuntimeException

Base Avro exception.

public class
AvroTypeException

Thrown when an illegal type is used.

public abstract class
Conversion<
a Java type that can represent the named logical type
T
>

Conversion between generic and logical type instances.

public class
public class
public class
public abstract class
JsonProperties

Base class for objects that have JSON-valued properties.

public class
LogicalType

Logical types provides an opt-in way to extend Avro's types.

public class
public class
Protocol

A set of messages forming an application protocol.

public class
Resolver

Encapsulate schema-resolution logic in an easy-to-consume representation.

public abstract class
Schema

An abstract data type.

public class
SchemaBuilder

A fluent interface for building Schema instances.

public class
SchemaBuilderException

Thrown for errors building schemas.

public class
SchemaCompatibility

Evaluate the compatibility between a reader schema and a writer schema.

public class
SchemaNormalization

Collection of static methods for generating the canonical form of schemas (see toParsingForm) -- and fingerprints of canonical forms (fingerprint).

public class
SchemaParseException

Thrown for errors parsing schemas and protocols.

public class
SchemaValidationException

Thrown when SchemaValidator fails to validate a schema.

public class
SchemaValidatorBuilder

A Builder for creating SchemaValidators.

public class
SystemLimitException

Thrown to prevent making large allocations when reading potentially pathological input data from an untrusted source.

public class
public class
UnresolvedUnionException

Thrown when the expected contents of a union cannot be resolved.

public class
ValidateAll

A SchemaValidator for validating the provided schema against all schemas in the Iterable in validate(Schema, Iterable).

pack-priv class
ValidateCanBeRead

A SchemaValidationStrategy that checks that the data written with the Schema to validate can be read by the existing schema according to the default Avro schema resolution rules.

pack-priv class
ValidateCanRead

A SchemaValidationStrategy that checks that the Schema to validate can read the existing schema according to the default Avro schema resolution rules.

public class
ValidateLatest

A SchemaValidator for validating the provided schema against the first Schema in the iterable in validate(Schema, Iterable).

pack-priv class
ValidateMutualRead

A SchemaValidationStrategy that checks that the Schema to validate and the existing schema can mutually read each other according to the default Avro schema resolution rules.