Modifier and Type	Class and Description
private static class	AvroSchema.Resolving Sub-class that does writer-to-reader conversion by using "resolving decoder" (by avro codec) on top of binary codec, exposing content using (reader) schema this instance was configured with.

Modifier and Type	Field and Description
protected final AtomicReference<AvroStructureReader>	_reader Lazily instantiated value reader for this schema.
protected final Schema	_writerSchema Schema that was used for writing the data to decode; for simple instance used for reading as well (reader schema).
public static final String	TYPE_ID Format type id used by Jackson components to refer to Avro Format.

Access	Constructor and Description
public	AvroSchema(Schema asch)

Method Summary

Modifier and Type	Method and Description
protected AvroStructureReader	_constructReader()
private boolean	_schemaNamesEqual(Schema w, Schema r)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Schema	getAvroSchema() Accessor for "writer schema" contained in this instance.
public AvroStructureReader	getReader()
public String	getSchemaType() Implements com.fasterxml.jackson.core.FormatSchema.getSchemaType. Method that can be used to get an identifier that can be used for diagnostics purposes, to indicate what kind of data format this schema is used for: typically it is a short name of format itself, but it can also contain additional information in cases where data format supports multiple types of schemas.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public AvroSchema	withReaderSchema(AvroSchema "Reader Schema" to use (in Avro terms): schema that specified how reader wants to see the data; specifies part of translation needed along with this schema (which would be "Writer Schema" in Avro terms). readerSchema) Method that will consider this schema instance (used as so-called "Writer Schema"), and specified "Reader Schema" instance, and will either construct a new schema with appropriate translations, to use for reading (if reader and writer schemas are not same); or, if schemas are the same, return `this`.
public AvroSchema	withUnsafeReaderSchema(AvroSchema readerSchema) Similar to `withReaderSchema` but will NOT verify compatibility of schemas: this means that certain problems (such as missing default value for a newly added field) that would be caught at construction may be surfaced later when using schema.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

_reader	back to summary
protected final AtomicReference<AvroStructureReader> _reader Lazily instantiated value reader for this schema.

_writerSchema	back to summary
protected final Schema _writerSchema Schema that was used for writing the data to decode; for simple instance used for reading as well (reader schema).

TYPE_ID	back to summary
public static final String TYPE_ID Format type id used by Jackson components to refer to Avro Format.

Constructor Detail

AvroSchema	back to summary
public AvroSchema(Schema asch)

Method Detail

_constructReader	back to summary
protected AvroStructureReader _constructReader() throws IOException

_schemaNamesEqual	back to summary
private boolean _schemaNamesEqual(Schema w, Schema r)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAvroSchema	back to summary
public Schema getAvroSchema() Accessor for "writer schema" contained in this instance.

getReader	back to summary
public AvroStructureReader getReader() throws IOException

getSchemaType	back to summary
public String getSchemaType() Implements com.fasterxml.jackson.core.FormatSchema.getSchemaType. Doc from com.fasterxml.jackson.core.FormatSchema.getSchemaType. Method that can be used to get an identifier that can be used for diagnostics purposes, to indicate what kind of data format this schema is used for: typically it is a short name of format itself, but it can also contain additional information in cases where data format supports multiple types of schemas. Returns:String Logical name of schema type Annotations @Override

getSchemaType

back to summary

public String getSchemaType()

Implements com.fasterxml.jackson.core.FormatSchema.getSchemaType.

Doc from com.fasterxml.jackson.core.FormatSchema.getSchemaType.

Method that can be used to get an identifier that can be used for diagnostics purposes, to indicate what kind of data format this schema is used for: typically it is a short name of format itself, but it can also contain additional information in cases where data format supports multiple types of schemas.

Returns:String

Logical name of schema type

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

withReaderSchema back to summary

withReaderSchema	back to summary
public AvroSchema withReaderSchema(AvroSchema readerSchema) throws JsonProcessingException Method that will consider this schema instance (used as so-called "Writer Schema"), and specified "Reader Schema" instance, and will either construct a new schema with appropriate translations, to use for reading (if reader and writer schemas are not same); or, if schemas are the same, return `this`. Note that neither `this` instance nor `readerSchema` is ever modified: if an altered version is needed, a new schema object will be constructed. Note this is a relatively expensive operation due to validation (although significant part of cost is deferred until the first call to `getReader`) so it is recommended that these instances are reused whenever possible. Parameters readerSchema:AvroSchema "Reader Schema" to use (in Avro terms): schema that specified how reader wants to see the data; specifies part of translation needed along with this schema (which would be "Writer Schema" in Avro terms). Exceptions JsonProcessingException: If given reader schema is incompatible with (writer-) schema this instance was constructed with, Since 2.9

public AvroSchema withReaderSchema(AvroSchema readerSchema) throws JsonProcessingException

Method that will consider this schema instance (used as so-called "Writer Schema"), and specified "Reader Schema" instance, and will either construct a new schema with appropriate translations, to use for reading (if reader and writer schemas are not same); or, if schemas are the same, return `this`.

Note that neither `this` instance nor `readerSchema` is ever modified: if an altered version is needed, a new schema object will be constructed.

Note

this is a relatively expensive operation due to validation (although significant part of cost is deferred until the first call to getReader) so it is recommended that these instances are reused whenever possible.

Parameters

readerSchema:AvroSchema: "Reader Schema" to use (in Avro terms): schema that specified how reader wants to see the data; specifies part of translation needed along with this schema (which would be "Writer Schema" in Avro terms).

Exceptions

JsonProcessingException:: If given reader schema is incompatible with (writer-) schema this instance was constructed with,

Since

2.9

withUnsafeReaderSchema back to summary

withUnsafeReaderSchema	back to summary
public AvroSchema withUnsafeReaderSchema(AvroSchema readerSchema) throws JsonProcessingException Similar to `withReaderSchema` but will NOT verify compatibility of schemas: this means that certain problems (such as missing default value for a newly added field) that would be caught at construction may be surfaced later when using schema. This is, however, sometimes necessary to work around potential BUT NOT ACTUAL problems. Since 2.9

public AvroSchema withUnsafeReaderSchema(AvroSchema readerSchema) throws JsonProcessingException

Similar to withReaderSchema but will NOT verify compatibility of schemas: this means that certain problems (such as missing default value for a newly added field) that would be caught at construction may be surfaced later when using schema. This is, however, sometimes necessary to work around potential BUT NOT ACTUAL problems.

Since: 2.9

com.fasterxml.jackson.dataformat.avro back to summary

private final Class AvroSchema.Resolving

Class Inheritance

extends AvroSchema

java.lang.Object
com.fasterxml.jackson.dataformat.avro.AvroSchema
com.fasterxml.jackson.dataformat.avro.AvroSchema.Resolving

Sub-class that does writer-to-reader conversion by using "resolving decoder" (by avro codec) on top of binary codec, exposing content using (reader) schema this instance was configured with.

Field Summary

Modifier and Type	Field and Description
private final Schema	_readerSchema

Inherited from com.fasterxml.jackson.dataformat.avro.AvroSchema:: _reader _writerSchema TYPE_ID

Constructor Summary

Access	Constructor and Description
public	Resolving(Schema writer, Schema reader)

Method Summary

Modifier and Type	Method and Description
protected AvroStructureReader	_constructReader() Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema._constructReader.
public static AvroSchema.Resolving	create(Schema writer, Schema reader)
public boolean	equals(Object the reference object with which to compare. o) Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.hashCode. Returns a hash code value for this object.
public String	toString() Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.toString. Returns a string representation of the object.

Inherited from com.fasterxml.jackson.dataformat.avro.AvroSchema:: getAvroSchema getReader getSchemaType withReaderSchema withUnsafeReaderSchema

Field Detail

_readerSchema	back to summary
private final Schema _readerSchema

Constructor Detail

Resolving	back to summary
public Resolving(Schema writer, Schema reader)

Method Detail

_constructReader	back to summary
protected AvroStructureReader _constructReader() throws IOException Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema._constructReader. Annotations @Override

_constructReader

back to summary

protected AvroStructureReader _constructReader() throws IOException

Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema._constructReader.

Annotations

@Override

create	back to summary
public static AvroSchema.Resolving create(Schema writer, Schema reader)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides com.fasterxml.jackson.dataformat.avro.AvroSchema.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class AvroSchema

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class AvroSchema.Resolving

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail