org.springframework.kafka.support

Class TopicPartitionInitialOffset

java.lang.Object

org.springframework.kafka.support.TopicPartitionInitialOffset

public class TopicPartitionInitialOffset
extends java.lang.Object

A configuration container to represent a topic name, partition number and, optionally, an initial offset for it. The initial offset can be:

• null - do nothing;
• positive (including 0) - seek to EITHER the absolute offset within the partition or an offset relative to the current position for this consumer, depending on isRelativeToCurrent().
• negative - seek to EITHER the offset relative to the current last offset within the partition: consumer.seekToEnd() + initialOffset OR the relative to the current offset for this consumer (if any), depending on isRelativeToCurrent().

Offsets are applied when the container is start()ed.

Author:

Artem Bilan, Gary Russell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopicPartitionInitialOffset.SeekPosition Enumeration for "special" seeks.

Constructor Summary

Constructors

Constructor and Description
TopicPartitionInitialOffset(java.lang.String topic, int partition) Construct an instance with no initial offset management.
TopicPartitionInitialOffset(java.lang.String topic, int partition, java.lang.Long initialOffset) Construct an instance with the provided initial offset with isRelativeToCurrent() false.
TopicPartitionInitialOffset(java.lang.String topic, int partition, java.lang.Long initialOffset, boolean relativeToCurrent) Construct an instance with the provided initial offset.
TopicPartitionInitialOffset(java.lang.String topic, int partition, TopicPartitionInitialOffset.SeekPosition position) Construct an instance with the provided TopicPartitionInitialOffset.SeekPosition.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
TopicPartitionInitialOffset.SeekPosition	getPosition()
int	hashCode()
java.lang.Long	initialOffset()
boolean	isRelativeToCurrent()
int	partition()
java.lang.String	topic()
org.apache.kafka.common.TopicPartition	topicPartition()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TopicPartitionInitialOffset

public TopicPartitionInitialOffset(java.lang.String topic,
                                   int partition)

Construct an instance with no initial offset management.

Parameters:

topic - the topic.

partition - the partition.

TopicPartitionInitialOffset

public TopicPartitionInitialOffset(java.lang.String topic,
                                   int partition,
                                   java.lang.Long initialOffset)

Construct an instance with the provided initial offset with isRelativeToCurrent() false.

Parameters:

topic - the topic.

partition - the partition.

initialOffset - the initial offset.

See Also:

TopicPartitionInitialOffset(String, int, Long, boolean)

TopicPartitionInitialOffset

public TopicPartitionInitialOffset(java.lang.String topic,
                                   int partition,
                                   java.lang.Long initialOffset,
                                   boolean relativeToCurrent)

Construct an instance with the provided initial offset.

Parameters:

topic - the topic.

partition - the partition.

initialOffset - the initial offset.

relativeToCurrent - true for the initial offset to be relative to the current consumer position, false for a positive initial offset to be absolute and a negative offset relative to the current end of the partition.

Since:

1.1

TopicPartitionInitialOffset

public TopicPartitionInitialOffset(java.lang.String topic,
                                   int partition,
                                   TopicPartitionInitialOffset.SeekPosition position)

Construct an instance with the provided TopicPartitionInitialOffset.SeekPosition.

Parameters:

topic - the topic.

partition - the partition.

position - TopicPartitionInitialOffset.SeekPosition.

Since:

1.3

Method Detail

topicPartition

public org.apache.kafka.common.TopicPartition topicPartition()

partition

public int partition()

topic

public java.lang.String topic()

initialOffset

public java.lang.Long initialOffset()

isRelativeToCurrent

public boolean isRelativeToCurrent()

getPosition

public TopicPartitionInitialOffset.SeekPosition getPosition()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object