MutableRecordReader (Flink : 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.flink.runtime.io.network.api.reader.AbstractReader
- - org.apache.flink.runtime.io.network.api.reader.MutableRecordReader<T>

Type Parameters:

T - The type of the record that is read.

All Implemented Interfaces:

MutableReader<T>, ReaderBase
```
public class MutableRecordReader<T extends IOReadableWritable>
extends AbstractReader
implements MutableReader<T>
```
Implementation of the record-oriented reader for mutable record types.

Field Summary
- Fields inherited from class org.apache.flink.runtime.io.network.api.reader.AbstractReader
  inputGate

Constructor Summary

Constructors
Constructor	Description
`MutableRecordReader(InputGate inputGate, String[] tmpDirectories)`	Creates a new MutableRecordReader that de-serializes records from the given input gate and can spill partial records to disk, if they grow large.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

void clearBuffers()

protected boolean getNextRecord(T target)

boolean next(T target)
- Methods inherited from class org.apache.flink.runtime.io.network.api.reader.AbstractReader
  handleEvent, hasReachedEndOfSuperstep, isFinished, publish, registerTaskEventListener, sendTaskEvent, setIterativeReader, startNextSuperstep
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.apache.flink.runtime.io.network.api.reader.ReaderBase
  hasReachedEndOfSuperstep, isFinished, registerTaskEventListener, sendTaskEvent, setIterativeReader, startNextSuperstep

- Constructor Detail
  - MutableRecordReader
```
public MutableRecordReader(InputGate inputGate,
                           String[] tmpDirectories)
```
    Creates a new MutableRecordReader that de-serializes records from the given input gate and can spill partial records to disk, if they grow large.
    
    Parameters:
    
    inputGate - The input gate to read from.
    
    tmpDirectories - The temp directories. USed for spilling if the reader concurrently reconstructs multiple large records.
- Method Detail
  - next
```
public boolean next(T target)
             throws IOException,
                    InterruptedException
```
    Specified by:
    
    next in interface MutableReader<T extends IOReadableWritable>
    
    Throws:
    
    IOException
    
    InterruptedException
  - clearBuffers
```
public void clearBuffers()
```
    Specified by:
    
    clearBuffers in interface MutableReader<T extends IOReadableWritable>
  - getNextRecord
```
protected boolean getNextRecord(T target)
                         throws IOException,
                                InterruptedException
```
    Throws:
    
    IOException
    
    InterruptedException