EnumValueSerializer (flink 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.flink.api.common.typeutils.TypeSerializer<scala.Enumeration.Value>
- - org.apache.flink.api.scala.typeutils.EnumValueSerializer<E>

All Implemented Interfaces:: Serializable

public class EnumValueSerializer<E extends scala.Enumeration>
extends TypeSerializer<scala.Enumeration.Value>

Serializer for Enumeration values.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

EnumValueSerializer(E enum_)

Constructors
Constructor and Description
`EnumValueSerializer(E enum_)`

Method Summary

All Methods Instance Methods Concrete Methods
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 src, DataOutputView tgt)` Copies exactly one record from the source input view to the target output view.
`scala.Enumeration.Value`	`copy(scala.Enumeration.Value from)` Creates a deep copy of the given element in a new element.
`scala.Enumeration.Value`	`copy(scala.Enumeration.Value from, scala.Enumeration.Value reuse)` Creates a copy from the given element.
`scala.Enumeration.Value`	`createInstance()` Creates a new instance of the data type.
`scala.Enumeration.Value`	`deserialize(DataInputView source)` De-serializes a record from the given source input view.
`scala.Enumeration.Value`	`deserialize(scala.Enumeration.Value reuse, DataInputView source)` De-serializes a record from the given source input view into the given reuse record instance if mutable.
`EnumValueSerializer<E>`	`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()`
`IntSerializer`	`intSerializer()`
`boolean`	`isImmutableType()` Gets whether the type is an immutable type.
`void`	`serialize(scala.Enumeration.Value v, DataOutputView tgt)` Serializes the given record to the given target output view.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EnumValueSerializer
```
public EnumValueSerializer(E enum_)
```
- Method Detail
  - intSerializer
```
public IntSerializer intSerializer()
```
  - duplicate
```
public EnumValueSerializer<E> duplicate()
```
    Description copied from class: TypeSerializer
    
    Creates a deep copy of this serializer if it is necessary, i.e. if it is stateful. This can return itself if the serializer is not stateful. We need this because Serializers might be used in several threads. Stateless serializers are inherently thread-safe while stateful serializers might not be thread-safe.
    
    Specified by:
    
    duplicate in class TypeSerializer<scala.Enumeration.Value>
  - createInstance
```
public scala.Enumeration.Value createInstance()
```
    Description copied from class: TypeSerializer
    
    Creates a new instance of the data type.
    
    Specified by:
    
    createInstance in class TypeSerializer<scala.Enumeration.Value>
    
    Returns:
    
    A new instance of the data type.
  - isImmutableType
```
public boolean isImmutableType()
```
    Description copied from class: TypeSerializer
    
    Gets whether the type is an immutable type.
    
    Specified by:
    
    isImmutableType in class TypeSerializer<scala.Enumeration.Value>
    
    Returns:
    
    True, if the type is immutable.
  - getLength
```
public int getLength()
```
    Description copied from class: TypeSerializer
    
    Gets the length of the data type, if it is a fix length data type.
    
    Specified by:
    
    getLength in class TypeSerializer<scala.Enumeration.Value>
    
    Returns:
    
    The length of the data type, or -1 for variable length data types.
  - copy
```
public scala.Enumeration.Value copy(scala.Enumeration.Value from)
```
    Description copied from class: TypeSerializer
    
    Creates a deep copy of the given element in a new element.
    
    Specified by:
    
    copy in class TypeSerializer<scala.Enumeration.Value>
    
    Parameters:
    
    from - The element reuse be copied.
    
    Returns:
    
    A deep copy of the element.
  - copy
```
public scala.Enumeration.Value copy(scala.Enumeration.Value from,
                                    scala.Enumeration.Value reuse)
```
    Description copied from class: TypeSerializer
    
    Creates a copy from the given element. The method makes an attempt to store the copy in the given reuse element, if the type is mutable. This is, however, not guaranteed.
    
    Specified by:
    
    copy in class TypeSerializer<scala.Enumeration.Value>
    
    Parameters:
    
    from - The element to be copied.
    
    reuse - The element to be reused. May or may not be used.
    
    Returns:
    
    A deep copy of the element.
  - copy
```
public void copy(DataInputView src,
                 DataOutputView tgt)
```
    Description copied from class: TypeSerializer
    
    Copies exactly one record from the source input view to the target output view. Whether this operation works on binary data or partially de-serializes the record to determine its length (such as for records of variable length) is up to the implementer. Binary copies are typically faster. A copy of a record containing two integer numbers (8 bytes total) is most efficiently implemented as target.write(source, 8);.
    
    Specified by:
    
    copy in class TypeSerializer<scala.Enumeration.Value>
    
    Parameters:
    
    src - The input view from which to read the record.
    
    tgt - The target output view to which to write the record.
  - serialize
```
public void serialize(scala.Enumeration.Value v,
                      DataOutputView tgt)
```
    Description copied from class: TypeSerializer
    
    Serializes the given record to the given target output view.
    
    Specified by:
    
    serialize in class TypeSerializer<scala.Enumeration.Value>
    
    Parameters:
    
    v - The record to serialize.
    
    tgt - The output view to write the serialized data to.
  - deserialize
```
public scala.Enumeration.Value deserialize(DataInputView source)
```
    Description copied from class: TypeSerializer
    
    De-serializes a record from the given source input view.
    
    Specified by:
    
    deserialize in class TypeSerializer<scala.Enumeration.Value>
    
    Parameters:
    
    source - The input view from which to read the data.
    
    Returns:
    
    The deserialized element.
  - deserialize
```
public scala.Enumeration.Value deserialize(scala.Enumeration.Value reuse,
                                           DataInputView source)
```
    Description copied from class: TypeSerializer
    
    De-serializes a record from the given source input view into the given reuse record instance if mutable.
    
    Specified by:
    
    deserialize in class TypeSerializer<scala.Enumeration.Value>
    
    Parameters:
    
    reuse - The record instance into which to de-serialize the data.
    
    source - The input view from which to read the data.
    
    Returns:
    
    The deserialized element.
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in class TypeSerializer<scala.Enumeration.Value>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class TypeSerializer<scala.Enumeration.Value>
  - canEqual
```
public boolean canEqual(Object obj)
```
    Description copied from class: TypeSerializer
    
    Returns true if the given object can be equaled with this object. If not, it returns false.
    
    Specified by:
    
    canEqual in class TypeSerializer<scala.Enumeration.Value>
    
    Parameters:
    
    obj - Object which wants to take part in the equality relation
    
    Returns:
    
    true if obj can be equaled with this, otherwise false

Back to Flink Website

Class EnumValueSerializer<E extends scala.Enumeration>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnumValueSerializer

Method Detail

intSerializer

duplicate

createInstance

isImmutableType

getLength

copy

copy

copy

serialize

deserialize

deserialize

equals

hashCode

canEqual

Back to Flink Website