RecordSerializer (flink-core 0.10.2-hadoop1 API)

java.lang.Object
- org.apache.flink.api.common.typeutils.TypeSerializer<Record>
- - org.apache.flink.api.common.typeutils.record.RecordSerializer

All Implemented Interfaces:

Serializable
```
public final class RecordSerializer
extends TypeSerializer<Record>
```
Implementation of the (de)serialization and copying logic for the Record.

See Also:
Serialized Form

Method Summary

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 source, DataOutputView target)` Copies exactly one record from the source input view to the target output view.
`Record`	`copy(Record from)` Creates a deep copy of the given element in a new element.
`Record`	`copy(Record from, Record reuse)` Creates a copy from the given element.
`Record`	`createInstance()` Creates a new instance of the data type.
`Record`	`deserialize(DataInputView source)` De-serializes a record from the given source input view.
`Record`	`deserialize(Record target, DataInputView source)` De-serializes a record from the given source input view into the given reuse record instance if mutable.
`RecordSerializer`	`duplicate()` Creates a deep copy of this serializer if it is necessary, i.e.
`boolean`	`equals(Object obj)`
`static RecordSerializer`	`get()`
`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(Record record, DataOutputView target)` 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

- Method Detail
  - get
```
public static RecordSerializer get()
```
  - isImmutableType
```
public boolean isImmutableType()
```
    Description copied from class: TypeSerializer
    
    Gets whether the type is an immutable type.
    
    Specified by:
    
    isImmutableType in class TypeSerializer<Record>
    
    Returns:
    True, if the type is immutable.
  - duplicate
```
public RecordSerializer 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<Record>
  - createInstance
```
public Record createInstance()
```
    Description copied from class: TypeSerializer
    
    Creates a new instance of the data type.
    
    Specified by:
    
    createInstance in class TypeSerializer<Record>
    
    Returns:
    A new instance of the data type.
  - copy
```
public Record copy(Record from)
```
    Description copied from class: TypeSerializer
    
    Creates a deep copy of the given element in a new element.
    
    Specified by:
    
    copy in class TypeSerializer<Record>
    
    Parameters:
    from - The element reuse be copied.
    
    Returns:
    A deep copy of the element.
  - copy
```
public Record copy(Record from,
          Record 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<Record>
    
    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.
  - 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<Record>
    
    Returns:
    The length of the data type, or -1 for variable length data types.
  - serialize
```
public void serialize(Record record,
             DataOutputView target)
               throws IOException
```
    Description copied from class: TypeSerializer
    
    Serializes the given record to the given target output view.
    
    Specified by:
    
    serialize in class TypeSerializer<Record>
    
    Parameters:
    record - The record to serialize.
    target - The output view to write the serialized data to.
    
    Throws:
    
    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.
  - deserialize
```
public Record deserialize(DataInputView source)
                   throws IOException
```
    Description copied from class: TypeSerializer
    
    De-serializes a record from the given source input view.
    
    Specified by:
    
    deserialize in class TypeSerializer<Record>
    
    Parameters:
    source - The input view from which to read the data.
    
    Returns:
    The deserialized element.
    
    Throws:
    
    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.
  - deserialize
```
public Record deserialize(Record target,
                 DataInputView source)
                   throws IOException
```
    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<Record>
    
    Parameters:
    target - The record instance into which to de-serialize the data.
    source - The input view from which to read the data.
    
    Returns:
    The deserialized element.
    
    Throws:
    
    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.
  - copy
```
public void copy(DataInputView source,
        DataOutputView target)
          throws IOException
```
    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<Record>
    
    Parameters:
    source - The input view from which to read the record.
    target - The target output view to which to write the record.
    
    Throws:
    
    IOException - Thrown if any of the two views raises an exception.
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in class TypeSerializer<Record>
  - 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<Record>
    
    Parameters:
    obj - Object which wants to take part in the equality relation
    
    Returns:
    true if obj can be equaled with this, otherwise false
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class TypeSerializer<Record>

Class RecordSerializer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

get

isImmutableType

duplicate

createInstance

copy

copy

getLength

serialize

deserialize

deserialize

copy

equals

canEqual

hashCode