Apache Avro 1.11.3 · org.apache.avro.data.RecordBuilderBase

Modifier and Type	Field and Description
private final GenericData	data
private final Schema.Field[]	fields
private final boolean[]	fieldSetFlags
private final Schema	schema

Access	Constructor and Description
protected	RecordBuilderBase(Schema the schema associated with the record class. schema, GenericData data) Creates a RecordBuilderBase for building records of the given type.
protected	RecordBuilderBase(RecordBuilderBase<T> RecordBuilderBase instance to copy. other, GenericData data) RecordBuilderBase copy constructor.

Method Summary

Modifier and Type	Method and Description
protected final GenericData	data()
protected Object	Returns: the default value associated with the given field, or null if none is specified in the schema. defaultValue(Schema.Field the field whose default value should be retrieved. field) Gets the default value of the given field, if any.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
protected final Schema.Field[]	fields()
protected final boolean[]	fieldSetFlags()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
protected static boolean	Returns: true if the value is valid for the given field; false otherwise. isValidValue(Schema.Field the field for which to test the value. f, Object the value to test. value) Tests whether a value is valid for a specified field.
protected final Schema	schema()
protected void	validate(Schema.Field the field to validate. field, Object the value to validate. value) Validates that a particular value for a given field is valid according to the following algorithm: 1.

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

data	back to summary
private final GenericData data

fields	back to summary
private final Schema.Field[] fields

fieldSetFlags	back to summary
private final boolean[] fieldSetFlags

schema	back to summary
private final Schema schema

RecordBuilderBase	back to summary
protected RecordBuilderBase(Schema schema, GenericData data) Creates a RecordBuilderBase for building records of the given type. Parameters schema:Schema the schema associated with the record class.

RecordBuilderBase	back to summary
protected RecordBuilderBase(RecordBuilderBase<T> other, GenericData data) RecordBuilderBase copy constructor. Makes a deep copy of the values in the other builder. Parameters other:RecordBuilderBase<T> RecordBuilderBase instance to copy.

Method Detail

data	back to summary
protected final GenericData data()

defaultValue	back to summary
protected Object defaultValue(Schema.Field field) throws IOException Gets the default value of the given field, if any. Parameters field:Schema.Field the field whose default value should be retrieved. Returns:Object the default value associated with the given field, or null if none is specified in the schema. Annotations @SuppressWarnings:rawtypes, unchecked

defaultValue

back to summary

protected Object defaultValue(Schema.Field field) throws IOException

Gets the default value of the given field, if any.

Parameters

field:Schema.Field: the field whose default value should be retrieved.

Returns:Object

the default value associated with the given field, or null if none is specified in the schema.

Annotations

@SuppressWarnings:rawtypes, unchecked

equals back to summary

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

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

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

fields	back to summary
protected final Schema.Field[] fields()

fieldSetFlags	back to summary
protected final boolean[] fieldSetFlags()

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

isValidValue	back to summary
protected static boolean isValidValue(Schema.Field f, Object value) Tests whether a value is valid for a specified field. Parameters f:Schema.Field the field for which to test the value. value:Object the value to test. Returns:boolean true if the value is valid for the given field; false otherwise.

isValidValue

back to summary

protected static boolean isValidValue(Schema.Field f, Object value)

Tests whether a value is valid for a specified field.

Parameters

f:Schema.Field: the field for which to test the value.
value:Object: the value to test.

Returns:boolean

true if the value is valid for the given field; false otherwise.

schema	back to summary
protected final Schema schema()

validate	back to summary
protected void validate(Schema.Field field, Object value) Validates that a particular value for a given field is valid according to the following algorithm: 1. If the value is not null, or the field type is null, or the field type is a union which accepts nulls, returns. 2. Else, if the field has a default value, returns. 3. Otherwise throws AvroRuntimeException. Parameters field:Schema.Field the field to validate. value:Object the value to validate. Exceptions AvroRuntimeException: if value is null and the given field does not accept null values.

validate

back to summary

protected void validate(Schema.Field field, Object value)

Validates that a particular value for a given field is valid according to the following algorithm: 1. If the value is not null, or the field type is null, or the field type is a union which accepts nulls, returns. 2. Else, if the field has a default value, returns. 3. Otherwise throws AvroRuntimeException.

Parameters

field:Schema.Field: the field to validate.
value:Object: the value to validate.

Exceptions

AvroRuntimeException:: if value is null and the given field does not accept null values.

public abstract Class RecordBuilderBase<T extends org.apache.avro.generic.IndexedRecord>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail