org.apache.flink.runtime.util

Class EnumUtils

java.lang.Object

org.apache.flink.runtime.util.EnumUtils

public final class EnumUtils
extends Object

Auxiliary class to (de)serialize enumeration values.

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends Enum<T>> T	readEnum(DataInput in, Class<T> enumType) Reads a value from the given enumeration from the specified input stream.
static void	writeEnum(DataOutput out, Enum<?> enumVal) Writes a value of an enumeration to the given output stream.

Methods inherited from class java.lang.Object

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

Method Detail

readEnum

public static <T extends Enum<T>> T readEnum(DataInput in,
                             Class<T> enumType)
                               throws IOException

Reads a value from the given enumeration from the specified input stream.

Type Parameters:

T - the type of the enumeration

Parameters:

in - the input stream to read from

enumType - the class of the enumeration

Returns:

the value of the given enumeration read from the input stream

Throws:

IOException - thrown if any error occurred while reading data from the stream

writeEnum

public static void writeEnum(DataOutput out,
             Enum<?> enumVal)
                      throws IOException

Writes a value of an enumeration to the given output stream.

Parameters:

out - the output stream to write to

enumVal - the value of a enumeration to be written to the output stream

Throws:

IOException - thrown if any error occurred while writing data to the stream