Skip to content

Commit 217ada7

Browse files
committed
Tx Javadoc Polishing
1 parent 29df442 commit 217ada7

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

spring-kafka/src/main/java/org/springframework/kafka/core/KafkaOperations.java

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -185,21 +185,23 @@ public interface KafkaOperations<K, V> {
185185
void flush();
186186

187187
/**
188-
* When running in a transaction (usually synchronized with some other transaction),
189-
* send the consumer offset(s) to the transaction. The group id is obtained from
190-
* {@link ProducerFactoryUtils#getConsumerGroupId()}. It is not necessary to call
191-
* this method if the operations are invoked on a listener container thread since the
192-
* container will take care of sending the offsets to the transaction.
188+
* When running in a transaction, send the consumer offset(s) to the transaction. The
189+
* group id is obtained from {@link ProducerFactoryUtils#getConsumerGroupId()}. It is
190+
* not necessary to call this method if the operations are invoked on a listener
191+
* container thread (and the listener container is configured with a
192+
* {@link org.springframework.kafka.transaction.KafkaAwareTransactionManager}) since
193+
* the container will take care of sending the offsets to the transaction.
193194
* @param offsets The offsets.
194195
* @since 1.3
195196
*/
196197
void sendOffsetsToTransaction(Map<TopicPartition, OffsetAndMetadata> offsets);
197198

198199
/**
199-
* When running in a transaction (usually synchronized with some other transaction),
200-
* send the consumer offset(s) to the transaction. It is not necessary to call this
201-
* method if the operations are invoked on a listener container thread since the
202-
* container will take care of sending the offsets to the transaction.
200+
* When running in a transaction, send the consumer offset(s) to the transaction. It
201+
* is not necessary to call this method if the operations are invoked on a listener
202+
* container thread (and the listener container is configured with a
203+
* {@link org.springframework.kafka.transaction.KafkaAwareTransactionManager}) since
204+
* the container will take care of sending the offsets to the transaction.
203205
* @param offsets The offsets.
204206
* @param consumerGroupId the consumer's group.id.
205207
* @since 1.3

0 commit comments

Comments
 (0)