T
- The data type that the deserializer deserializes.@Internal public final class TypeDeserializerAdapter<T> extends TypeSerializer<T> implements TypeDeserializer<T>
TypeSerializer
and TypeDeserializer
.
It either wraps a type deserializer or serializer, and can only ever be used for deserialization
(i.e. only read-related methods is functional).
Methods related to deserialization are directly forwarded to the wrapped deserializer or serializer, while serialization methods are masked and not intended for use.
Constructor and Description |
---|
TypeDeserializerAdapter(TypeDeserializer<T> deserializer)
Creates a
TypeDeserializerAdapter that wraps a TypeDeserializer . |
TypeDeserializerAdapter(TypeSerializer<T> serializer)
Creates a
TypeDeserializerAdapter that wraps a TypeSerializer . |
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.
|
CompatibilityResult<T> |
ensureCompatibility(TypeSerializerConfigSnapshot configSnapshot)
Ensure compatibility of this serializer with a preceding serializer that was registered for serialization of
the same managed state (if any - this method is only relevant if this serializer is registered for
serialization of managed state).
|
boolean |
equals(Object obj) |
int |
getLength()
Gets the length of the data type, if it is a fix length data type.
|
int |
hashCode() |
boolean |
isImmutableType()
Gets whether the type is an immutable type.
|
void |
serialize(T record,
DataOutputView target)
Serializes the given record to the given target output view.
|
TypeSerializerConfigSnapshot |
snapshotConfiguration()
Create a snapshot of the serializer's current configuration to be stored along with the managed state it is
registered to (if any - this method is only relevant if this serializer is registered for serialization of
managed state).
|
public TypeDeserializerAdapter(TypeDeserializer<T> deserializer)
TypeDeserializerAdapter
that wraps a TypeDeserializer
.deserializer
- the actual deserializer to wrap.public TypeDeserializerAdapter(TypeSerializer<T> serializer)
TypeDeserializerAdapter
that wraps a TypeSerializer
.serializer
- the actual serializer to wrap.public T deserialize(DataInputView source) throws IOException
TypeSerializer
deserialize
in interface TypeDeserializer<T>
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 interface TypeDeserializer<T>
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 TypeSerializer<T> duplicate()
TypeSerializer
duplicate
in interface TypeDeserializer<T>
duplicate
in class TypeSerializer<T>
public int getLength()
TypeSerializer
getLength
in interface TypeDeserializer<T>
getLength
in class TypeSerializer<T>
-1
for variable length data types.public boolean equals(Object obj)
equals
in interface TypeDeserializer<T>
equals
in class TypeSerializer<T>
public boolean canEqual(Object obj)
TypeSerializer
canEqual
in interface TypeDeserializer<T>
canEqual
in class TypeSerializer<T>
obj
- Object which wants to take part in the equality relationpublic int hashCode()
hashCode
in interface TypeDeserializer<T>
hashCode
in class TypeSerializer<T>
public boolean isImmutableType()
TypeSerializer
isImmutableType
in class TypeSerializer<T>
public T createInstance()
TypeSerializer
createInstance
in class TypeSerializer<T>
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 serialize(T record, DataOutputView target) throws IOException
TypeSerializer
serialize
in class TypeSerializer<T>
record
- 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 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 TypeSerializerConfigSnapshot snapshotConfiguration()
TypeSerializer
The configuration snapshot should contain information about the serializer's parameter settings and its serialization format. When a new serializer is registered to serialize the same managed state that this serializer was registered to, the returned configuration snapshot can be used to ensure compatibility of the new serializer and determine if state migration is required.
snapshotConfiguration
in class TypeSerializer<T>
null
).TypeSerializerConfigSnapshot
public CompatibilityResult<T> ensureCompatibility(TypeSerializerConfigSnapshot configSnapshot)
TypeSerializer
The result can be one of the following:
CompatibilityResult.compatible()
: this signals Flink that this serializer is compatible, or
has been reconfigured to be compatible, to continue reading previous data, and that the
serialization schema remains the same. No migration needs to be performed.CompatibilityResult.requiresMigration(TypeDeserializer)
: this signals Flink that
migration needs to be performed, because this serializer is not compatible, or cannot be reconfigured to be
compatible, for previous data. Furthermore, in the case that the preceding serializer cannot be found or
restored to read the previous data to perform the migration, the provided convert deserializer can be
used as a fallback resort.CompatibilityResult.requiresMigration()
: this signals Flink that migration needs to be
performed, because this serializer is not compatible, or cannot be reconfigured to be compatible, for
previous data. If the preceding serializer cannot be found (either its implementation changed or it was
removed from the classpath) then the migration will fail due to incapability to read previous data.ensureCompatibility
in class TypeSerializer<T>
configSnapshot
- configuration snapshot of a preceding serializer for the same managed statenull
).CompatibilityResult
Copyright © 2014–2019 The Apache Software Foundation. All rights reserved.