org.apache.flink.api.common.typeutils.base

Class EnumSerializer.EnumSerializerConfigSnapshot<T extends Enum<T>>

java.lang.Object

org.apache.flink.core.io.VersionedIOReadableWritable

org.apache.flink.api.common.typeutils.TypeSerializerConfigSnapshot

org.apache.flink.api.common.typeutils.GenericTypeSerializerConfigSnapshot<T>

org.apache.flink.api.common.typeutils.base.EnumSerializer.EnumSerializerConfigSnapshot<T>

Type Parameters:

T - the enum type.

All Implemented Interfaces:

IOReadableWritable, Versioned

Enclosing class:

EnumSerializer<T extends Enum<T>>

public static final class EnumSerializer.EnumSerializerConfigSnapshot<T extends Enum<T>>
extends GenericTypeSerializerConfigSnapshot<T>

Configuration snapshot of a serializer for enumerations. Configuration contains the enum class, and an array of the enum's constants that existed when the configuration snapshot was taken.

Constructor Summary

Constructors

Constructor and Description
EnumSerializerConfigSnapshot() This empty nullary constructor is required for deserializing the configuration.
EnumSerializerConfigSnapshot(Class<T> enumClass, T[] enumConstantsArr)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int[]	getCompatibleVersions() Returns the compatible version values.
List<String>	getEnumConstants()
int	getVersion() Returns the version number of the object.
int	hashCode()
void	read(DataInputView in) Reads the object's internal data from the given data input view.
void	write(DataOutputView out) Writes the object's internal data to the given data output view.

Methods inherited from class org.apache.flink.api.common.typeutils.GenericTypeSerializerConfigSnapshot

getTypeClass

Methods inherited from class org.apache.flink.api.common.typeutils.TypeSerializerConfigSnapshot

getUserCodeClassLoader, setUserCodeClassLoader

Methods inherited from class org.apache.flink.core.io.VersionedIOReadableWritable

getReadVersion

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnumSerializerConfigSnapshot

public EnumSerializerConfigSnapshot()

This empty nullary constructor is required for deserializing the configuration.

EnumSerializerConfigSnapshot

public EnumSerializerConfigSnapshot(Class<T> enumClass,
                                    T[] enumConstantsArr)

Method Detail

write

public void write(DataOutputView out)
           throws IOException

Description copied from interface: IOReadableWritable

Writes the object's internal data to the given data output view.

Specified by:

write in interface IOReadableWritable

Overrides:

write in class GenericTypeSerializerConfigSnapshot<T extends Enum<T>>

Parameters:

out - the output view to receive the data.

Throws:

IOException - thrown if any error occurs while writing to the output stream

read

public void read(DataInputView in)
          throws IOException

Description copied from interface: IOReadableWritable

Reads the object's internal data from the given data input view.

Specified by:

read in interface IOReadableWritable

Overrides:

read in class GenericTypeSerializerConfigSnapshot<T extends Enum<T>>

Parameters:

in - the input view to read the data from

Throws:

IOException - thrown if any error occurs while reading from the input stream

getVersion

public int getVersion()

Description copied from interface: Versioned

Returns the version number of the object. Versions numbers can be used to differentiate evolving classes.

getCompatibleVersions

public int[] getCompatibleVersions()

Description copied from class: VersionedIOReadableWritable

Returns the compatible version values.

By default, the base implementation recognizes only the current version (identified by Versioned.getVersion()) as compatible. This method can be used as a hook and may be overridden to identify more compatible versions.

Overrides:

getCompatibleVersions in class VersionedIOReadableWritable

Returns:

an array of integers representing the compatible version values.

getEnumConstants

public List<String> getEnumConstants()

equals

public boolean equals(Object obj)

Overrides:

equals in class GenericTypeSerializerConfigSnapshot<T extends Enum<T>>

hashCode

public int hashCode()

Overrides:

hashCode in class GenericTypeSerializerConfigSnapshot<T extends Enum<T>>