Apache Avro 1.11.3 · org.apache.avro.specific.SpecificRecordBase

Access	Constructor and Description
public	SpecificRecordBase()

Method Summary

Modifier and Type	Method and Description
public int	compareTo(SpecificRecord the object to be compared. that) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public void	customDecode(ResolvingDecoder in)
public void	customEncode(Encoder out)
public boolean	equals(Object the reference object with which to compare. that) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public abstract Object	get(int field) Redeclares org.apache.avro.generic.IndexedRecord.get. Return the value of a field given its position in the schema.
public Object	get(String fieldName) Implements org.apache.avro.generic.GenericRecord.get. Return the value of a field given its name.
public Conversion<?>	getConversion(int field)
public Conversion<?>	getConversion(String fieldName)
public abstract Schema	getSchema() Redeclares org.apache.avro.generic.GenericContainer.getSchema. The schema of this instance.
public SpecificData	getSpecificData()
protected boolean	hasCustomCoders() Returns true iff an instance supports the `MessageEncoder#encode` and `MessageDecoder#decode` operations.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public abstract void	put(int field, Object value) Redeclares org.apache.avro.generic.IndexedRecord.put. Set the value of a field given its position in the schema.
public void	put(String fieldName, Object value) Implements org.apache.avro.generic.GenericRecord.put. Set the value of a field given its name.
public void	readExternal(ObjectInput the stream to read data from in order to restore the object in) Implements java.io.Externalizable.readExternal. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writeExternal(ObjectOutput the stream to write the object to out) Implements java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

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

SpecificRecordBase	back to summary
public SpecificRecordBase()

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(SpecificRecord that) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters that:SpecificRecord the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(SpecificRecord that)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

that:SpecificRecord: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

customDecode	back to summary
public void customDecode(ResolvingDecoder in) throws IOException

customEncode	back to summary
public void customEncode(Encoder out) throws IOException

equals back to summary

equals	back to summary
public boolean equals(Object that) 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 that: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 that)

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

that: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

get back to summary

get	back to summary
public abstract Object get(int field) Redeclares org.apache.avro.generic.IndexedRecord.get. Doc from org.apache.avro.generic.IndexedRecord.get. Return the value of a field given its position in the schema. This method is not meant to be called by user code, but only by `org.apache.avro.io.DatumWriter` implementations. Annotations @Override

public abstract Object get(int field)

Redeclares org.apache.avro.generic.IndexedRecord.get.

Doc from org.apache.avro.generic.IndexedRecord.get.

Return the value of a field given its position in the schema.

This method is not meant to be called by user code, but only by org.apache.avro.io.DatumWriter implementations.

Annotations

@Override

get	back to summary
public Object get(String fieldName) Implements org.apache.avro.generic.GenericRecord.get. Doc from org.apache.avro.generic.GenericRecord.get. Return the value of a field given its name. Annotations @Override

get

back to summary

public Object get(String fieldName)

Implements org.apache.avro.generic.GenericRecord.get.

Doc from org.apache.avro.generic.GenericRecord.get.

Return the value of a field given its name.

Annotations

@Override

getConversion	back to summary
public Conversion<?> getConversion(int field)

getConversion	back to summary
public Conversion<?> getConversion(String fieldName)

getSchema	back to summary
public abstract Schema getSchema() Redeclares org.apache.avro.generic.GenericContainer.getSchema. Doc from org.apache.avro.generic.GenericContainer.getSchema. The schema of this instance. Annotations @Override

getSchema

back to summary

public abstract Schema getSchema()

Redeclares org.apache.avro.generic.GenericContainer.getSchema.

Doc from org.apache.avro.generic.GenericContainer.getSchema.

The schema of this instance.

Annotations

@Override

getSpecificData	back to summary
public SpecificData getSpecificData()

hasCustomCoders	back to summary
protected boolean hasCustomCoders() Returns true iff an instance supports the `MessageEncoder#encode` and `MessageDecoder#decode` operations. Should only be used by `SpecificDatumReader/Writer` to selectively use `customEncode` and `customDecode` to optimize the (de)serialization of values.

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 the 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 the 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

put back to summary

put	back to summary
public abstract void put(int field, Object value) Redeclares org.apache.avro.generic.IndexedRecord.put. Doc from org.apache.avro.generic.IndexedRecord.put. Set the value of a field given its position in the schema. This method is not meant to be called by user code, but only by `org.apache.avro.io.DatumReader` implementations. Annotations @Override

public abstract void put(int field, Object value)

Redeclares org.apache.avro.generic.IndexedRecord.put.

Doc from org.apache.avro.generic.IndexedRecord.put.

Set the value of a field given its position in the schema.

This method is not meant to be called by user code, but only by org.apache.avro.io.DatumReader implementations.

Annotations

@Override

put	back to summary
public void put(String fieldName, Object value) Implements org.apache.avro.generic.GenericRecord.put. Doc from org.apache.avro.generic.GenericRecord.put. Set the value of a field given its name. Annotations @Override

put

back to summary

public void put(String fieldName, Object value)

Implements org.apache.avro.generic.GenericRecord.put.

Doc from org.apache.avro.generic.GenericRecord.put.

Set the value of a field given its name.

Annotations

@Override

readExternal	back to summary
public void readExternal(ObjectInput in) throws IOException Implements java.io.Externalizable.readExternal. Doc from java.io.Externalizable.readExternal. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal. Parameters in:ObjectInput the stream to read data from in order to restore the object Annotations @Override Exceptions IOException: if I/O errors occur

readExternal

back to summary

public void readExternal(ObjectInput in) throws IOException

Implements java.io.Externalizable.readExternal.

Doc from java.io.Externalizable.readExternal.

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Parameters

in:ObjectInput: the stream to read data from in order to restore the object

Annotations

@Override

Exceptions

IOException:: if I/O errors occur

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. Returns:String a string representation of the object. Annotations @Override

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.

Returns:String

a string representation of the object.

Annotations

@Override

writeExternal	back to summary
public void writeExternal(ObjectOutput out) throws IOException Implements java.io.Externalizable.writeExternal. Doc from java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays. Parameters out:ObjectOutput the stream to write the object to Annotations @Override Exceptions IOException: Includes any I/O exceptions that may occur

writeExternal

back to summary

public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Doc from java.io.Externalizable.writeExternal.

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Parameters

out:ObjectOutput: the stream to write the object to

Annotations

@Override

Exceptions

IOException:: Includes any I/O exceptions that may occur

public abstract Class SpecificRecordBase

Constructor Summary

Method Summary

Constructor Detail

Method Detail