T
- The type to be serialized.public class AvroSerializer<T> extends TypeSerializer<T>
The serializer supports:
Important: This serializer is NOT THREAD SAFE, because it reuses the data encoders and decoders which have buffers that would be shared between the threads if used concurrently
Modifier and Type | Class and Description |
---|---|
static class |
AvroSerializer.AvroSchemaSerializerConfigSnapshot<T>
Deprecated.
|
Constructor and Description |
---|
AvroSerializer(Class<T> type)
Creates a new AvroSerializer for the type indicated by the given class.
|
AvroSerializer(Class<T> type,
Class<? extends T> typeToInstantiate)
Deprecated.
Use
AvroSerializer(Class) instead. |
AvroSerializer(Class<T> type,
org.apache.avro.Schema schema)
Creates a new AvroSerializer for the type indicated by the given class.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canEqual(Object obj)
Returns true if the given object can be equaled with this object.
|
void |
copy(DataInputView source,
DataOutputView target)
Copies exactly one record from the source input view to the target output view.
|
T |
copy(T from)
Creates a deep copy of the given element in a new element.
|
T |
copy(T from,
T reuse)
Creates a copy from the given element.
|
T |
createInstance()
Creates a new instance of the data type.
|
T |
deserialize(DataInputView source)
De-serializes a record from the given source input view.
|
T |
deserialize(T reuse,
DataInputView source)
De-serializes a record from the given source input view into the given reuse record instance if mutable.
|
TypeSerializer<T> |
duplicate()
Creates a deep copy of this serializer if it is necessary, i.e.
|
boolean |
equals(Object obj) |
int |
getLength()
Gets the length of the data type, if it is a fix length data type.
|
Class<T> |
getType() |
int |
hashCode() |
boolean |
isImmutableType()
Gets whether the type is an immutable type.
|
void |
serialize(T value,
DataOutputView target)
Serializes the given record to the given target output view.
|
TypeSerializerSnapshot<T> |
snapshotConfiguration()
Snapshots the configuration of this TypeSerializer.
|
String |
toString() |
ensureCompatibility
public AvroSerializer(Class<T> type)
SpecificRecord
or reflection serializer.
For serializing GenericData.Record
use AvroSerializer(Class, Schema)
public AvroSerializer(Class<T> type, org.apache.avro.Schema schema)
GenericData.Record
.
For SpecificRecord
or reflection serializer use
AvroSerializer(Class)
@Deprecated public AvroSerializer(Class<T> type, Class<? extends T> typeToInstantiate)
AvroSerializer(Class)
instead.public boolean isImmutableType()
TypeSerializer
isImmutableType
in class TypeSerializer<T>
public int getLength()
TypeSerializer
getLength
in class TypeSerializer<T>
-1
for variable length data types.public T createInstance()
TypeSerializer
createInstance
in class TypeSerializer<T>
public void serialize(T value, DataOutputView target) throws IOException
TypeSerializer
serialize
in class TypeSerializer<T>
value
- The record to serialize.target
- The output view to write the serialized data to.IOException
- Thrown, if the serialization encountered an I/O related error. Typically raised by the
output view, which may have an underlying I/O channel to which it delegates.public T deserialize(DataInputView source) throws IOException
TypeSerializer
deserialize
in class TypeSerializer<T>
source
- The input view from which to read the data.IOException
- Thrown, if the de-serialization encountered an I/O related error. Typically raised by the
input view, which may have an underlying I/O channel from which it reads.public T deserialize(T reuse, DataInputView source) throws IOException
TypeSerializer
deserialize
in class TypeSerializer<T>
reuse
- The record instance into which to de-serialize the data.source
- The input view from which to read the data.IOException
- Thrown, if the de-serialization encountered an I/O related error. Typically raised by the
input view, which may have an underlying I/O channel from which it reads.public T copy(T from)
TypeSerializer
copy
in class TypeSerializer<T>
from
- The element reuse be copied.public T copy(T from, T reuse)
TypeSerializer
copy
in class TypeSerializer<T>
from
- The element to be copied.reuse
- The element to be reused. May or may not be used.public void copy(DataInputView source, DataOutputView target) throws IOException
TypeSerializer
target.write(source, 8);
.copy
in class TypeSerializer<T>
source
- The input view from which to read the record.target
- The target output view to which to write the record.IOException
- Thrown if any of the two views raises an exception.public TypeSerializerSnapshot<T> snapshotConfiguration()
TypeSerializer
The snapshot of the TypeSerializer is supposed to contain all information that affects the serialization format of the serializer. The snapshot serves two purposes: First, to reproduce the serializer when the checkpoint/savepoint is restored, and second, to check whether the serialization format is compatible with the serializer used in the restored program.
IMPORTANT: TypeSerializerSnapshots changed after Flink 1.6. Serializers implemented against Flink versions up to 1.6 should still work, but adjust to new model to enable state evolution and be future-proof. See the class-level comments, section "Upgrading TypeSerializers to the new TypeSerializerSnapshot model" for details.
snapshotConfiguration
in class TypeSerializer<T>
null
).TypeSerializerSnapshot.resolveSchemaCompatibility(TypeSerializer)
public TypeSerializer<T> duplicate()
TypeSerializer
duplicate
in class TypeSerializer<T>
public int hashCode()
hashCode
in class TypeSerializer<T>
public boolean equals(Object obj)
equals
in class TypeSerializer<T>
public boolean canEqual(Object obj)
TypeSerializer
canEqual
in class TypeSerializer<T>
obj
- Object which wants to take part in the equality relationCopyright © 2014–2020 The Apache Software Foundation. All rights reserved.