BlockingQueueRecordReader (easy-batch-core 7.0.2 API)

java.lang.Object
- org.jeasy.batch.core.reader.BlockingQueueRecordReader<P>

Type Parameters:

P - type of the record's payload

All Implemented Interfaces:

RecordReader<P>
```
public class BlockingQueueRecordReader<P>
extends java.lang.Object
implements RecordReader<P>
```
A RecordReader that reads record from a BlockingQueue.

Author:

Mahmoud Ben Hassine ([email protected])

Field Summary

Fields
Modifier and Type Field Description

static long DEFAULT_TIMEOUT

Constructor Summary

Constructors
Constructor	Description
`BlockingQueueRecordReader(java.util.concurrent.BlockingQueue<Record<P>> queue)`	Create a new `BlockingQueueRecordReader`.
`BlockingQueueRecordReader(java.util.concurrent.BlockingQueue<Record<P>> queue, long timeout)`	Create a new `BlockingQueueRecordReader`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

Record<P> readRecord()
Read next record from the data source.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.jeasy.batch.core.reader.RecordReader
  close, open

- Field Detail
  - DEFAULT_TIMEOUT
```
public static final long DEFAULT_TIMEOUT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BlockingQueueRecordReader
```
public BlockingQueueRecordReader(java.util.concurrent.BlockingQueue<Record<P>> queue)
```
    Create a new BlockingQueueRecordReader.
    
    Parameters:
    
    queue - the queue to read records from
  - BlockingQueueRecordReader
```
public BlockingQueueRecordReader(java.util.concurrent.BlockingQueue<Record<P>> queue,
                                 long timeout)
```
    Create a new BlockingQueueRecordReader.
    
    Parameters:
    
    queue - the queue to read records from
    
    timeout - in milliseconds after which the reader will return null
- Method Detail
  - readRecord
```
public Record<P> readRecord()
                     throws java.lang.Exception
```
    Description copied from interface: RecordReader
    
    Read next record from the data source.
    
    Specified by:
    
    readRecord in interface RecordReader<P>
    
    Returns:
    
    the next record from the data source or null if the end of the data source is reached
    
    Throws:
    
    java.lang.Exception - if an error occurs during reading next record