@Internal public final class EnumSerializer<T extends Enum<T>> extends TypeSerializer<T>
TypeSerializer for Java enums.| Modifier and Type | Class and Description |
|---|---|
static class |
EnumSerializer.EnumSerializerConfigSnapshot<T extends Enum<T>>
Deprecated.
|
static class |
EnumSerializer.EnumSerializerSnapshot<T extends Enum<T>>
|
| Constructor and Description |
|---|
EnumSerializer(Class<T> enumClass) |
| Modifier and Type | Method and Description |
|---|---|
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.
|
EnumSerializer<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.
|
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.
|
EnumSerializer.EnumSerializerSnapshot<T> |
snapshotConfiguration()
Snapshots the configuration of this TypeSerializer.
|
String |
toString() |
public boolean isImmutableType()
TypeSerializerisImmutableType in class TypeSerializer<T extends Enum<T>>public EnumSerializer<T> duplicate()
TypeSerializerWe need this because Serializers might be used in several threads. Stateless serializers are inherently thread-safe while stateful serializers might not be thread-safe.
duplicate in class TypeSerializer<T extends Enum<T>>public T createInstance()
TypeSerializercreateInstance in class TypeSerializer<T extends Enum<T>>public T copy(T from)
TypeSerializercopy in class TypeSerializer<T extends Enum<T>>from - The element reuse be copied.public T copy(T from, T reuse)
TypeSerializercopy in class TypeSerializer<T extends Enum<T>>from - The element to be copied.reuse - The element to be reused. May or may not be used.public int getLength()
TypeSerializergetLength in class TypeSerializer<T extends Enum<T>>-1 for variable length data types.public void serialize(T record, DataOutputView target) throws IOException
TypeSerializerserialize in class TypeSerializer<T extends Enum<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 T deserialize(DataInputView source) throws IOException
TypeSerializerdeserialize in class TypeSerializer<T extends Enum<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
TypeSerializerdeserialize in class TypeSerializer<T extends Enum<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 void copy(DataInputView source, DataOutputView target) throws IOException
TypeSerializertarget.write(source, 8);.copy in class TypeSerializer<T extends Enum<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 boolean equals(Object obj)
equals in class TypeSerializer<T extends Enum<T>>public int hashCode()
hashCode in class TypeSerializer<T extends Enum<T>>public EnumSerializer.EnumSerializerSnapshot<T> snapshotConfiguration()
TypeSerializerThe 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 extends Enum<T>>null).TypeSerializerSnapshot.resolveSchemaCompatibility(TypeSerializer)Copyright © 2014–2021 The Apache Software Foundation. All rights reserved.