com.opendxl.databus.consumer

Class ConsumerRecords<P>

java.lang.Object

com.opendxl.databus.consumer.ConsumerRecords<P>

All Implemented Interfaces:

java.lang.Iterable<ConsumerRecord>

public class ConsumerRecords<P>
extends java.lang.Object
implements java.lang.Iterable<ConsumerRecord>

This class contains a set of ConsumerRecord. It is returned by Consumer.poll(long). Since it implements Iterable the SDK user can iterate using a for structure.

Field Summary

Fields

Modifier and Type	Field and Description
static ConsumerRecords	EMPTY The consumer record instance.

Constructor Summary

Constructors

Constructor and Description
ConsumerRecords(java.util.Map<TopicPartition,java.util.List<ConsumerRecord<P>>> records) Constructor for the consumer record Map.

Method Summary

Modifier and Type	Method and Description
int	count() Gets total of records contained in the records object instance.
static ConsumerRecords	empty() Gets an empty set of the consumer records map.
boolean	isEmpty() Gets a boolean value that checks if the records map if empty.
java.util.Iterator<ConsumerRecord>	iterator()
java.util.Set<TopicPartition>	partitions() Gets the topic partition Set object for the records Map.
java.lang.Iterable<ConsumerRecord>	records(java.lang.String topic) Gets an Iterable instance of ConsumerRecord list.
java.util.List<ConsumerRecord>	records(TopicPartition partition) Gets the consumer ConsumerRecord list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY

public static final ConsumerRecords EMPTY

The consumer record instance.

Constructor Detail

ConsumerRecords

public ConsumerRecords(java.util.Map<TopicPartition,java.util.List<ConsumerRecord<P>>> records)

Constructor for the consumer record Map.

Parameters:

records - a Map that groups a list of records for each Partition.

Throws:

org.apache.commons.lang.NullArgumentException - when records is null.

Method Detail

empty

public static ConsumerRecords empty()

Gets an empty set of the consumer records map.

Returns:

And empty consumer records object.

records

public java.util.List<ConsumerRecord> records(TopicPartition partition)

Gets the consumer ConsumerRecord list.

Parameters:

partition - The topic partition name to get the partition number.

Returns:

A list of ConsumerRecord object.

records

public java.lang.Iterable<ConsumerRecord> records(java.lang.String topic)

Gets an Iterable instance of ConsumerRecord list.

Parameters:

topic - The topic name.

Returns:

An iterable list of ConsumerRecord.

partitions

public java.util.Set<TopicPartition> partitions()

Gets the topic partition Set object for the records Map.

Returns:

The TopicPartition Set.

iterator

public java.util.Iterator<ConsumerRecord> iterator()

Specified by:

iterator in interface java.lang.Iterable<ConsumerRecord>

count

public int count()

Gets total of records contained in the records object instance.

Returns:

The total records number as int.

isEmpty

public boolean isEmpty()

Gets a boolean value that checks if the records map if empty.

Returns:

True if the records maps if empty.