Skip to content

Commit edd7c6d

Browse files
committed
Fix Javadocs For Removed Error Handlers
1 parent 777d7f3 commit edd7c6d

8 files changed

+16
-16
lines changed

spring-kafka/src/main/java/org/springframework/kafka/config/AbstractKafkaListenerContainerFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,8 @@ public void setRecoveryCallback(RecoveryCallback<? extends Object> recoveryCallb
197197

198198
/**
199199
* When using a {@link RetryTemplate} Set to true to enable stateful retry. Use in
200-
* conjunction with a
201-
* {@link org.springframework.kafka.listener.SeekToCurrentErrorHandler} when retry can
200+
* conjunction with a legacy
201+
* {@code org.springframework.kafka.listener.SeekToCurrentErrorHandler} when retry can
202202
* take excessive time; each failure goes back to the broker, to keep the Consumer
203203
* alive.
204204
* @param statefulRetry true to enable stateful retry.

spring-kafka/src/main/java/org/springframework/kafka/config/AbstractKafkaListenerEndpoint.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,8 +376,8 @@ protected boolean isStatefulRetry() {
376376

377377
/**
378378
* When using a {@link RetryTemplate}, set to true to enable stateful retry. Use in
379-
* conjunction with a
380-
* {@link org.springframework.kafka.listener.SeekToCurrentErrorHandler} when retry can
379+
* conjunction with a legacy
380+
* {@code org.springframework.kafka.listener.SeekToCurrentErrorHandler} when retry can
381381
* take excessive time; each failure goes back to the broker, to keep the Consumer
382382
* alive.
383383
* @param statefulRetry true to enable stateful retry.

spring-kafka/src/main/java/org/springframework/kafka/listener/CommonContainerStoppingErrorHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929

3030
/**
3131
* A {@link CommonErrorHandler} that stops the container when an error occurs. Replaces
32-
* the legacy {@link ContainerStoppingErrorHandler} and
33-
* {@link ContainerStoppingBatchErrorHandler}.
32+
* the legacy {@code ContainerStoppingErrorHandler} and
33+
* {@code ContainerStoppingBatchErrorHandler}.
3434
*
3535
* @author Gary Russell
3636
* @since 2.8

spring-kafka/src/main/java/org/springframework/kafka/listener/ConsumerAwareListenerErrorHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2017-2020 the original author or authors.
2+
* Copyright 2017-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@
2323
/**
2424
* An error handler that has access to the consumer. IMPORTANT: do not perform seek
2525
* operations on the consumer, the container won't be aware. Use a container-level error
26-
* handler such as the {@link SeekToCurrentErrorHandler} for such situations.
26+
* handler such as the {@link DefaultErrorHandler} for such situations.
2727
*
2828
* @author Gary Russell
2929
* @since 2.0

spring-kafka/src/main/java/org/springframework/kafka/listener/DefaultErrorHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
* not provided in the exception, error handling is delegated to a
3939
* {@link FallbackBatchErrorHandler} with this handler's {@link BackOff}. If the record is
4040
* recovered, its offset is committed. This is a replacement for the legacy
41-
* {@link SeekToCurrentErrorHandler} and {@link SeekToCurrentBatchErrorHandler} (but the
41+
* {@code SeekToCurrentErrorHandler} and {@code SeekToCurrentBatchErrorHandler} (but the
4242
* fallback now can send the messages to a recoverer after retries are completed instead
4343
* of retrying indefinitely).
4444
*

spring-kafka/src/main/java/org/springframework/kafka/listener/PartitionPausingBackoffManager.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2018-2021 the original author or authors.
2+
* Copyright 2018-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@
3232
/**
3333
*
3434
* A manager that backs off consumption for a given topic if the timestamp provided is not
35-
* due. Use with {@link SeekToCurrentErrorHandler} to guarantee that the message is read
35+
* due. Use with {@link DefaultErrorHandler} to guarantee that the message is read
3636
* again after partition consumption is resumed (or seek it manually by other means).
3737
* It's also necessary to set a {@link ContainerProperties#setIdlePartitionEventInterval(Long)}
3838
* so the Manager can resume the partition consumption.
@@ -43,7 +43,7 @@
4343
* @author Tomaz Fernandes
4444
* @author Gary Russell
4545
* @since 2.7
46-
* @see SeekToCurrentErrorHandler
46+
* @see DefaultErrorHandler
4747
*/
4848
public class PartitionPausingBackoffManager implements KafkaConsumerBackoffManager,
4949
ApplicationListener<ListenerContainerPartitionIdleEvent> {

spring-kafka/src/main/java/org/springframework/kafka/listener/adapter/RetryingMessageListenerAdapter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2016-2021 the original author or authors.
2+
* Copyright 2016-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -90,7 +90,7 @@ public RetryingMessageListenerAdapter(MessageListener<K, V> messageListener, Ret
9090
* Construct an instance with the provided template, callback and delegate. When using
9191
* stateful retry, the retry context key is a concatenated String
9292
* {@code topic-partition-offset}. A
93-
* {@link org.springframework.kafka.listener.SeekToCurrentErrorHandler} is required in
93+
* {@link org.springframework.kafka.listener.DefaultErrorHandler} is required in
9494
* the listener container because stateful retry will throw the exception to the
9595
* container for each delivery attempt.
9696
* @param messageListener the delegate listener.

spring-kafka/src/main/java/org/springframework/kafka/retrytopic/RetryTopicConfigurer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
* <p>How it works:
5757
*
5858
* <p>If a message processing throws an exception, the configured
59-
* {@link org.springframework.kafka.listener.SeekToCurrentErrorHandler}
59+
* {@link org.springframework.kafka.listener.DefaultErrorHandler}
6060
* and {@link org.springframework.kafka.listener.DeadLetterPublishingRecoverer} forwards the message to the next topic, using a
6161
* {@link org.springframework.kafka.retrytopic.DestinationTopicResolver}
6262
* to know the next topic and the delay for it.
@@ -196,7 +196,7 @@
196196
* @see org.springframework.kafka.annotation.RetryableTopic
197197
* @see org.springframework.kafka.annotation.KafkaListener
198198
* @see org.springframework.retry.annotation.Backoff
199-
* @see org.springframework.kafka.listener.SeekToCurrentErrorHandler
199+
* @see org.springframework.kafka.listener.DefaultErrorHandler
200200
* @see org.springframework.kafka.listener.DeadLetterPublishingRecoverer
201201
*
202202
*/

0 commit comments

Comments
 (0)