root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

MINOR: cleanup JavaDocs for deprecation warnings (#18402) 

Reviewers: Bill Bejeck <bbejeck@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
This commit is contained in:
Matthias J. Sax 2025-01-07 01:18:33 -08:00 committed by GitHub
parent 7b6e94642a
commit 738bd928f1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 48 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
clients/src/main/java/org/apache/kafka/clients/admin/ConsumerGroupDescription.java
View File

@ -47,7 +47,7 @@ public class ConsumerGroupDescription {
private final Optional<Integer> targetAssignmentEpoch; private final Optional<Integer> targetAssignmentEpoch;
/** /**
* @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)}. * @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)} instead.
*/ */
@Deprecated @Deprecated
public ConsumerGroupDescription(String groupId, public ConsumerGroupDescription(String groupId,
@ -60,7 +60,7 @@ public class ConsumerGroupDescription {
} }
/** /**
* @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)}. * @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)} instead.
*/ */
@Deprecated @Deprecated
public ConsumerGroupDescription(String groupId, public ConsumerGroupDescription(String groupId,
@ -74,7 +74,7 @@ public class ConsumerGroupDescription {
} }
/** /**
* @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)}. * @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)} instead.
*/ */
@Deprecated @Deprecated
public ConsumerGroupDescription(String groupId, public ConsumerGroupDescription(String groupId,

6
clients/src/main/java/org/apache/kafka/clients/admin/ConsumerGroupListing.java
View File

@ -49,7 +49,7 @@ public class ConsumerGroupListing {
* @param groupId Group Id. * @param groupId Group Id.
* @param isSimpleConsumerGroup If consumer group is simple or not. * @param isSimpleConsumerGroup If consumer group is simple or not.
* @param state The state of the consumer group. * @param state The state of the consumer group.
* @deprecated Since 4.0. Use {@link #ConsumerGroupListing(String, Optional, boolean)}. * @deprecated Since 4.0. Use {@link #ConsumerGroupListing(String, Optional, boolean)} instead.
*/ */
@Deprecated @Deprecated
public ConsumerGroupListing(String groupId, boolean isSimpleConsumerGroup, Optional<ConsumerGroupState> state) { public ConsumerGroupListing(String groupId, boolean isSimpleConsumerGroup, Optional<ConsumerGroupState> state) {
@ -63,7 +63,7 @@ public class ConsumerGroupListing {
* @param isSimpleConsumerGroup If consumer group is simple or not. * @param isSimpleConsumerGroup If consumer group is simple or not.
* @param state The state of the consumer group. * @param state The state of the consumer group.
* @param type The type of the consumer group. * @param type The type of the consumer group.
* @deprecated Since 4.0. Use {@link #ConsumerGroupListing(String, Optional, Optional, boolean)}. * @deprecated Since 4.0. Use {@link #ConsumerGroupListing(String, Optional, Optional, boolean)} instead.
*/ */
@Deprecated @Deprecated
public ConsumerGroupListing( public ConsumerGroupListing(
@ -133,7 +133,7 @@ public class ConsumerGroupListing {
/** /**
* Consumer Group state * Consumer Group state
* @deprecated Since 4.0. Use {@link #groupState()}. * @deprecated Since 4.0. Use {@link #groupState()} instead.
*/ */
@Deprecated @Deprecated
public Optional<ConsumerGroupState> state() { public Optional<ConsumerGroupState> state() {

4
clients/src/main/java/org/apache/kafka/clients/admin/CreateDelegationTokenOptions.java
View File

@ -54,7 +54,7 @@ public class CreateDelegationTokenOptions extends AbstractOptions<CreateDelegati
} }
/** /**
* @deprecated since 4.0 and should not be used any longer. * @deprecated Since 4.0 and should not be used any longer.
*/ */
@Deprecated @Deprecated
public CreateDelegationTokenOptions maxlifeTimeMs(long maxLifetimeMs) { public CreateDelegationTokenOptions maxlifeTimeMs(long maxLifetimeMs) {
@ -68,7 +68,7 @@ public class CreateDelegationTokenOptions extends AbstractOptions<CreateDelegati
} }
/** /**
* @deprecated since 4.0 and should not be used any longer. * @deprecated Since 4.0 and should not be used any longer.
*/ */
@Deprecated @Deprecated
public long maxlifeTimeMs() { public long maxlifeTimeMs() {

4
clients/src/main/java/org/apache/kafka/clients/admin/ListConsumerGroupsOptions.java
View File

@ -52,7 +52,7 @@ public class ListConsumerGroupsOptions extends AbstractOptions<ListConsumerGroup
* If states is set, only groups in these states will be returned by listConsumerGroups(). * If states is set, only groups in these states will be returned by listConsumerGroups().
* Otherwise, all groups are returned. * Otherwise, all groups are returned.
* This operation is supported by brokers with version 2.6.0 or later. * This operation is supported by brokers with version 2.6.0 or later.
* @deprecated Since 4.0. Use {@link #inGroupStates(Set)}. * @deprecated Since 4.0. Use {@link #inGroupStates(Set)} instead.
*/ */
@Deprecated @Deprecated
public ListConsumerGroupsOptions inStates(Set<ConsumerGroupState> states) { public ListConsumerGroupsOptions inStates(Set<ConsumerGroupState> states) {
@ -80,7 +80,7 @@ public class ListConsumerGroupsOptions extends AbstractOptions<ListConsumerGroup
/** /**
* Returns the list of States that are requested or empty if no states have been specified. * Returns the list of States that are requested or empty if no states have been specified.
* @deprecated Since 4.0. Use {@link #inGroupStates(Set)}. * @deprecated Since 4.0. Use {@link #inGroupStates(Set)} instead.
*/ */
@Deprecated @Deprecated
public Set<ConsumerGroupState> states() { public Set<ConsumerGroupState> states() {

6
clients/src/main/java/org/apache/kafka/clients/admin/MemberDescription.java
View File

@ -57,7 +57,7 @@ public class MemberDescription {
} }
/** /**
* @deprecated Since 4.0. Use {@link #MemberDescription(String, Optional, String, String, MemberAssignment, Optional, Optional, Optional)}. * @deprecated Since 4.0. Use {@link #MemberDescription(String, Optional, String, String, MemberAssignment, Optional, Optional, Optional)} instead.
*/ */
@Deprecated @Deprecated
public MemberDescription( public MemberDescription(
@ -81,7 +81,7 @@ public class MemberDescription {
} }
/** /**
* @deprecated Since 4.0. Use {@link #MemberDescription(String, Optional, String, String, MemberAssignment, Optional, Optional, Optional)}. * @deprecated Since 4.0. Use {@link #MemberDescription(String, Optional, String, String, MemberAssignment, Optional, Optional, Optional)} instead.
*/ */
@Deprecated @Deprecated
public MemberDescription( public MemberDescription(
@ -102,7 +102,7 @@ public class MemberDescription {
} }
/** /**
* @deprecated Since 4.0. Use {@link #MemberDescription(String, Optional, String, String, MemberAssignment, Optional, Optional, Optional)}. * @deprecated Since 4.0. Use {@link #MemberDescription(String, Optional, String, String, MemberAssignment, Optional, Optional, Optional)} instead.
*/ */
@Deprecated @Deprecated
public MemberDescription(String memberId, public MemberDescription(String memberId,

3
clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerRecords.java
View File

@ -37,6 +37,9 @@ public class ConsumerRecords<K, V> implements Iterable<ConsumerRecord<K, V>> {
private final Map<TopicPartition, List<ConsumerRecord<K, V>>> records; private final Map<TopicPartition, List<ConsumerRecord<K, V>>> records;
private final Map<TopicPartition, OffsetAndMetadata> nextOffsets; private final Map<TopicPartition, OffsetAndMetadata> nextOffsets;
/**
* @deprecated Since 4.0. Use {@link #ConsumerRecords(Map, Map)} instead.
*/
@Deprecated @Deprecated
public ConsumerRecords(Map<TopicPartition, List<ConsumerRecord<K, V>>> records) { public ConsumerRecords(Map<TopicPartition, List<ConsumerRecord<K, V>>> records) {
this(records, Map.of()); this(records, Map.of());

2
clients/src/main/java/org/apache/kafka/clients/consumer/MockConsumer.java
View File

@ -82,7 +82,7 @@ public class MockConsumer<K, V> implements Consumer<K, V> {
private final List<KafkaMetric> addedMetrics = new ArrayList<>(); private final List<KafkaMetric> addedMetrics = new ArrayList<>();
/** /**
* @deprecated Since 4.0. Use {@link #MockConsumer(String)}. * @deprecated Since 4.0. Use {@link #MockConsumer(String)} instead.
*/ */
@Deprecated @Deprecated
public MockConsumer(OffsetResetStrategy offsetResetStrategy) { public MockConsumer(OffsetResetStrategy offsetResetStrategy) {

2
clients/src/main/java/org/apache/kafka/clients/consumer/OffsetResetStrategy.java
View File

@ -19,7 +19,7 @@ package org.apache.kafka.clients.consumer;
import java.util.Locale; import java.util.Locale;
/** /**
* @deprecated Since 4.0. Use {@link org.apache.kafka.clients.consumer.internals.AutoOffsetResetStrategy instead.} * @deprecated Since 4.0. Use {@link org.apache.kafka.clients.consumer.internals.AutoOffsetResetStrategy} instead.
*/ */
@Deprecated @Deprecated
public enum OffsetResetStrategy { public enum OffsetResetStrategy {

3
clients/src/main/java/org/apache/kafka/common/errors/RecordDeserializationException.java
View File

@ -45,6 +45,9 @@ public class RecordDeserializationException extends SerializationException {
private final ByteBuffer valueBuffer; private final ByteBuffer valueBuffer;
private final Headers headers; private final Headers headers;
/**
* @deprecated Since 3.9. Use {@link #RecordDeserializationException(DeserializationExceptionOrigin, TopicPartition, long, long, TimestampType, ByteBuffer, ByteBuffer, Headers, String, Throwable)} instead.
*/
@Deprecated @Deprecated
public RecordDeserializationException(TopicPartition partition, public RecordDeserializationException(TopicPartition partition,
long offset, long offset,

16
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
View File

@ -165,6 +165,7 @@ public class StreamsConfig extends AbstractConfig {
@Deprecated @Deprecated
@SuppressWarnings("unused") @SuppressWarnings("unused")
public static final int DUMMY_THREAD_INDEX = 1; public static final int DUMMY_THREAD_INDEX = 1;
public static final long MAX_TASK_IDLE_MS_DISABLED = -1; public static final long MAX_TASK_IDLE_MS_DISABLED = -1;
// We impose these limitations because client tags are encoded into the subscription info, // We impose these limitations because client tags are encoded into the subscription info,
@ -486,7 +487,7 @@ public class StreamsConfig extends AbstractConfig {
private static final String BUILT_IN_METRICS_VERSION_DOC = "Version of the built-in metrics to use."; private static final String BUILT_IN_METRICS_VERSION_DOC = "Version of the built-in metrics to use.";
/** {@code cache.max.bytes.buffering} /** {@code cache.max.bytes.buffering}
* @deprecated since 3.4.0 Use {@link #STATESTORE_CACHE_MAX_BYTES_CONFIG "statestore.cache.max.bytes"} instead. */ * @deprecated Since 3.4. Use {@link #STATESTORE_CACHE_MAX_BYTES_CONFIG "statestore.cache.max.bytes"} instead. */
@SuppressWarnings("WeakerAccess") @SuppressWarnings("WeakerAccess")
@Deprecated @Deprecated
public static final String CACHE_MAX_BYTES_BUFFERING_CONFIG = "cache.max.bytes.buffering"; public static final String CACHE_MAX_BYTES_BUFFERING_CONFIG = "cache.max.bytes.buffering";
@ -520,7 +521,7 @@ public class StreamsConfig extends AbstractConfig {
/** /**
* {@code default.deserialization.exception.handler} * {@code default.deserialization.exception.handler}
* @deprecated since 4.0; use {@link #DESERIALIZATION_EXCEPTION_HANDLER_CLASS_CONFIG} instead * @deprecated Since 4.0. Use {@link #DESERIALIZATION_EXCEPTION_HANDLER_CLASS_CONFIG} instead.
*/ */
@SuppressWarnings("WeakerAccess") @SuppressWarnings("WeakerAccess")
@Deprecated @Deprecated
@ -535,7 +536,7 @@ public class StreamsConfig extends AbstractConfig {
/** /**
* {@code default.production.exception.handler} * {@code default.production.exception.handler}
* @deprecated since 4.0; Use {@link #PRODUCTION_EXCEPTION_HANDLER_CLASS_CONFIG} instead * @deprecated Since 4.0. Use {@link #PRODUCTION_EXCEPTION_HANDLER_CLASS_CONFIG} instead.
*/ */
@SuppressWarnings("WeakerAccess") @SuppressWarnings("WeakerAccess")
@Deprecated @Deprecated
@ -546,7 +547,10 @@ public class StreamsConfig extends AbstractConfig {
public static final String PRODUCTION_EXCEPTION_HANDLER_CLASS_CONFIG = "production.exception.handler"; public static final String PRODUCTION_EXCEPTION_HANDLER_CLASS_CONFIG = "production.exception.handler";
private static final String PRODUCTION_EXCEPTION_HANDLER_CLASS_DOC = "Exception handling class that implements the <code>org.apache.kafka.streams.errors.ProductionExceptionHandler</code> interface."; private static final String PRODUCTION_EXCEPTION_HANDLER_CLASS_DOC = "Exception handling class that implements the <code>org.apache.kafka.streams.errors.ProductionExceptionHandler</code> interface.";
/** {@code default.dsl.store} */ /**
* {@code default.dsl.store}
* @deprecated Since 3.7. Use {@link #DSL_STORE_SUPPLIERS_CLASS_CONFIG} instead.
*/
@Deprecated @Deprecated
@SuppressWarnings("WeakerAccess") @SuppressWarnings("WeakerAccess")
public static final String DEFAULT_DSL_STORE_CONFIG = "default.dsl.store"; public static final String DEFAULT_DSL_STORE_CONFIG = "default.dsl.store";
@ -2021,7 +2025,7 @@ public class StreamsConfig extends AbstractConfig {
} }
/** /**
* @deprecated since kafka 4.0; use {@link #deserializationExceptionHandler()} instead * @deprecated Since 4.0. Use {@link #deserializationExceptionHandler()} instead.
*/ */
@Deprecated @Deprecated
@SuppressWarnings("WeakerAccess") @SuppressWarnings("WeakerAccess")
@ -2043,7 +2047,7 @@ public class StreamsConfig extends AbstractConfig {
} }
/** /**
* @deprecated since kafka 4.0; use {@link #productionExceptionHandler()} instead * @deprecated Since 4.0. Use {@link #productionExceptionHandler()} instead.
*/ */
@Deprecated @Deprecated
@SuppressWarnings("WeakerAccess") @SuppressWarnings("WeakerAccess")

3
streams/src/main/java/org/apache/kafka/streams/errors/DefaultProductionExceptionHandler.java
View File

@ -26,6 +26,9 @@ import java.util.Map;
* happens while attempting to produce result records. * happens while attempting to produce result records.
*/ */
public class DefaultProductionExceptionHandler implements ProductionExceptionHandler { public class DefaultProductionExceptionHandler implements ProductionExceptionHandler {
/**
* @deprecated Since 3.9. Use {@link #handle(ErrorHandlerContext, ProducerRecord, Exception)} instead.
*/
@SuppressWarnings("deprecation") @SuppressWarnings("deprecation")
@Deprecated @Deprecated
@Override @Override

3
streams/src/main/java/org/apache/kafka/streams/errors/LogAndContinueExceptionHandler.java
View File

@ -31,6 +31,9 @@ import java.util.Map;
public class LogAndContinueExceptionHandler implements DeserializationExceptionHandler { public class LogAndContinueExceptionHandler implements DeserializationExceptionHandler {
private static final Logger log = LoggerFactory.getLogger(LogAndContinueExceptionHandler.class); private static final Logger log = LoggerFactory.getLogger(LogAndContinueExceptionHandler.class);
/**
* @deprecated Since 3.9. Use {@link #handle(ErrorHandlerContext, ConsumerRecord, Exception)} instead.
*/
@SuppressWarnings("deprecation") @SuppressWarnings("deprecation")
@Deprecated @Deprecated
@Override @Override

3
streams/src/main/java/org/apache/kafka/streams/errors/LogAndFailExceptionHandler.java
View File

@ -31,6 +31,9 @@ import java.util.Map;
public class LogAndFailExceptionHandler implements DeserializationExceptionHandler { public class LogAndFailExceptionHandler implements DeserializationExceptionHandler {
private static final Logger log = LoggerFactory.getLogger(LogAndFailExceptionHandler.class); private static final Logger log = LoggerFactory.getLogger(LogAndFailExceptionHandler.class);
/**
* @deprecated Since 3.9. Use {@link #handle(ErrorHandlerContext, ConsumerRecord, Exception)} instead.
*/
@SuppressWarnings("deprecation") @SuppressWarnings("deprecation")
@Deprecated @Deprecated
@Override @Override

2
streams/src/main/java/org/apache/kafka/streams/kstream/ForeachProcessor.java
View File

@ -20,7 +20,7 @@ import org.apache.kafka.streams.processor.api.Processor;
import org.apache.kafka.streams.processor.api.Record; import org.apache.kafka.streams.processor.api.Record;
/** /**
* @deprecated since 4.0 and should not be used any longer. * @deprecated Since 4.0 and should not be used any longer.
*/ */
@Deprecated @Deprecated
public class ForeachProcessor<K, V> implements Processor<K, V, Void, Void> { public class ForeachProcessor<K, V> implements Processor<K, V, Void, Void> {

4
streams/src/main/java/org/apache/kafka/streams/kstream/JoinWindows.java
View File

@ -154,7 +154,7 @@ public class JoinWindows extends Windows<Window> {
* @param timeDifference join window interval * @param timeDifference join window interval
* @return a new JoinWindows object with the window definition with and grace period (default to 24 hours minus {@code timeDifference}) * @return a new JoinWindows object with the window definition with and grace period (default to 24 hours minus {@code timeDifference})
* @throws IllegalArgumentException if {@code timeDifference} is negative or can't be represented as {@code long milliseconds} * @throws IllegalArgumentException if {@code timeDifference} is negative or can't be represented as {@code long milliseconds}
* @deprecated since 3.0. Use {@link #ofTimeDifferenceWithNoGrace(Duration)}} instead * @deprecated Since 3.0. Use {@link #ofTimeDifferenceWithNoGrace(Duration)}} instead.
*/ */
@Deprecated @Deprecated
public static JoinWindows of(final Duration timeDifference) throws IllegalArgumentException { public static JoinWindows of(final Duration timeDifference) throws IllegalArgumentException {
@ -221,7 +221,7 @@ public class JoinWindows extends Windows<Window> {
* @return this updated builder * @return this updated builder
* @throws IllegalArgumentException if the {@code afterWindowEnd} is negative or can't be represented as {@code long milliseconds} * @throws IllegalArgumentException if the {@code afterWindowEnd} is negative or can't be represented as {@code long milliseconds}
* @throws IllegalStateException if {@link #grace(Duration)} is called after {@link #ofTimeDifferenceAndGrace(Duration, Duration)} or {@link #ofTimeDifferenceWithNoGrace(Duration)} * @throws IllegalStateException if {@link #grace(Duration)} is called after {@link #ofTimeDifferenceAndGrace(Duration, Duration)} or {@link #ofTimeDifferenceWithNoGrace(Duration)}
* @deprecated since 3.0. Use {@link #ofTimeDifferenceAndGrace(Duration, Duration)} instead * @deprecated Since 3.0. Use {@link #ofTimeDifferenceAndGrace(Duration, Duration)} instead.
*/ */
@Deprecated @Deprecated
public JoinWindows grace(final Duration afterWindowEnd) throws IllegalArgumentException { public JoinWindows grace(final Duration afterWindowEnd) throws IllegalArgumentException {

8
streams/src/main/java/org/apache/kafka/streams/kstream/Joined.java
View File

@ -273,7 +273,7 @@ public class Joined<K, VLeft, VRight> implements NamedOperation<Joined<K, VLeft,
/** /**
* @deprecated since 4.0 and should not be used any longer. * @deprecated Since 4.0 and should not be used any longer.
*/ */
@Deprecated @Deprecated
public Duration gracePeriod() { public Duration gracePeriod() {
@ -281,7 +281,7 @@ public class Joined<K, VLeft, VRight> implements NamedOperation<Joined<K, VLeft,
} }
/** /**
* @deprecated since 4.0 and should not be used any longer. * @deprecated Since 4.0 and should not be used any longer.
*/ */
@Deprecated @Deprecated
public Serde<K> keySerde() { public Serde<K> keySerde() {
@ -289,7 +289,7 @@ public class Joined<K, VLeft, VRight> implements NamedOperation<Joined<K, VLeft,
} }
/** /**
* @deprecated since 4.0 and should not be used any longer. * @deprecated Since 4.0 and should not be used any longer.
*/ */
@Deprecated @Deprecated
public Serde<VLeft> valueSerde() { public Serde<VLeft> valueSerde() {
@ -297,7 +297,7 @@ public class Joined<K, VLeft, VRight> implements NamedOperation<Joined<K, VLeft,
} }
/** /**
* @deprecated since 4.0 and should not be used any longer. * @deprecated Since 4.0 and should not be used any longer.
*/ */
@Deprecated @Deprecated
public Serde<VRight> otherValueSerde() { public Serde<VRight> otherValueSerde() {

2
tools/src/main/java/org/apache/kafka/tools/TopicCommand.java
View File

@ -709,7 +709,7 @@ public abstract class TopicCommand {
private final ArgumentAcceptingOptionSpec<String> configOpt; private final ArgumentAcceptingOptionSpec<String> configOpt;
/** /**
* @deprecated since 4.0 and should not be used any longer. * @deprecated Since 4.0 and should not be used any longer.
*/ */
@Deprecated @Deprecated
private final ArgumentAcceptingOptionSpec<String> deleteConfigOpt; private final ArgumentAcceptingOptionSpec<String> deleteConfigOpt;