This is an automated email from the ASF dual-hosted git repository.
kkarantasis pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new 4f690794 MINOR: fix linking errors in javadoc (#8198)
4f690794 is described below
commit 4f6907947a95db48876dd331133d349236d5152a
Author: Chia-Ping Tsai <[email protected]>
AuthorDate: Mon Mar 23 01:15:18 2020 +0800
MINOR: fix linking errors in javadoc (#8198)
This improvement fixes several linking errors to classes and methods from
within javadocs.
Related to #8291
Reviewers: Konstantine Karantasis <[email protected]>
---
clients/src/main/java/org/apache/kafka/clients/Metadata.java | 2 +-
.../kafka/clients/admin/AlterConsumerGroupOffsetsOptions.java | 4 +++-
.../java/org/apache/kafka/clients/admin/ElectLeadersOptions.java | 3 +++
.../java/org/apache/kafka/clients/admin/ElectLeadersResult.java | 3 +++
.../apache/kafka/clients/admin/ElectPreferredLeadersOptions.java | 5 ++++-
.../apache/kafka/clients/admin/ElectPreferredLeadersResult.java | 2 ++
.../java/org/apache/kafka/clients/admin/ListOffsetsOptions.java | 2 ++
.../src/main/java/org/apache/kafka/clients/admin/OffsetSpec.java | 1 +
.../apache/kafka/clients/consumer/internals/RequestFuture.java | 4 +++-
.../java/org/apache/kafka/common/ClusterResourceListener.java | 8 ++++----
clients/src/main/java/org/apache/kafka/common/ElectionType.java | 6 ++++--
.../src/main/java/org/apache/kafka/connect/source/SourceTask.java | 2 +-
.../kafka/streams/integration/utils/IntegrationTestUtils.java | 2 +-
13 files changed, 32 insertions(+), 12 deletions(-)
diff --git a/clients/src/main/java/org/apache/kafka/clients/Metadata.java
b/clients/src/main/java/org/apache/kafka/clients/Metadata.java
index 7116e2e..c5c6d04 100644
--- a/clients/src/main/java/org/apache/kafka/clients/Metadata.java
+++ b/clients/src/main/java/org/apache/kafka/clients/Metadata.java
@@ -248,7 +248,7 @@ public class Metadata implements Closeable {
* is set for topics if required and expired topics are removed from the
metadata.
*
* @param requestVersion The request version corresponding to the update
response, as provided by
- * {@link #newMetadataRequestAndVersion()}.
+ * {@link #newMetadataRequestAndVersion(long)}.
* @param response metadata response received from the broker
* @param isPartialUpdate whether the metadata request was for a subset of
the active topics
* @param nowMs current time in milliseconds
diff --git
a/clients/src/main/java/org/apache/kafka/clients/admin/AlterConsumerGroupOffsetsOptions.java
b/clients/src/main/java/org/apache/kafka/clients/admin/AlterConsumerGroupOffsetsOptions.java
index eb8b8ec..f630b48 100644
---
a/clients/src/main/java/org/apache/kafka/clients/admin/AlterConsumerGroupOffsetsOptions.java
+++
b/clients/src/main/java/org/apache/kafka/clients/admin/AlterConsumerGroupOffsetsOptions.java
@@ -18,8 +18,10 @@ package org.apache.kafka.clients.admin;
import org.apache.kafka.common.annotation.InterfaceStability;
+import java.util.Map;
+
/**
- * Options for the {@link AdminClient#alterConsumerGroupOffsets(String, Map)}
call.
+ * Options for the {@link AdminClient#alterConsumerGroupOffsets(String, Map,
AlterConsumerGroupOffsetsOptions)} call.
*
* The API of this class is evolving, see {@link AdminClient} for details.
*/
diff --git
a/clients/src/main/java/org/apache/kafka/clients/admin/ElectLeadersOptions.java
b/clients/src/main/java/org/apache/kafka/clients/admin/ElectLeadersOptions.java
index db79976..ae03ebe 100644
---
a/clients/src/main/java/org/apache/kafka/clients/admin/ElectLeadersOptions.java
+++
b/clients/src/main/java/org/apache/kafka/clients/admin/ElectLeadersOptions.java
@@ -17,8 +17,11 @@
package org.apache.kafka.clients.admin;
+import org.apache.kafka.common.ElectionType;
import org.apache.kafka.common.annotation.InterfaceStability;
+import java.util.Set;
+
/**
* Options for {@link Admin#electLeaders(ElectionType, Set,
ElectLeadersOptions)}.
*
diff --git
a/clients/src/main/java/org/apache/kafka/clients/admin/ElectLeadersResult.java
b/clients/src/main/java/org/apache/kafka/clients/admin/ElectLeadersResult.java
index 92da4fc..186c584 100644
---
a/clients/src/main/java/org/apache/kafka/clients/admin/ElectLeadersResult.java
+++
b/clients/src/main/java/org/apache/kafka/clients/admin/ElectLeadersResult.java
@@ -20,6 +20,9 @@ package org.apache.kafka.clients.admin;
import java.util.Map;
import java.util.Optional;
+import java.util.Set;
+
+import org.apache.kafka.common.ElectionType;
import org.apache.kafka.common.KafkaFuture;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.annotation.InterfaceStability;
diff --git
a/clients/src/main/java/org/apache/kafka/clients/admin/ElectPreferredLeadersOptions.java
b/clients/src/main/java/org/apache/kafka/clients/admin/ElectPreferredLeadersOptions.java
index c00c920..e5e3859 100644
---
a/clients/src/main/java/org/apache/kafka/clients/admin/ElectPreferredLeadersOptions.java
+++
b/clients/src/main/java/org/apache/kafka/clients/admin/ElectPreferredLeadersOptions.java
@@ -17,12 +17,15 @@
package org.apache.kafka.clients.admin;
+import org.apache.kafka.common.ElectionType;
import org.apache.kafka.common.annotation.InterfaceStability;
+
import java.util.Collection;
+import java.util.Set;
/**
* Options for {@link Admin#electPreferredLeaders(Collection,
ElectPreferredLeadersOptions)}.
- *
+ * <p>
* The API of this class is evolving, see {@link Admin} for details.
*
* @deprecated Since 2.4.0. Use {@link Admin#electLeaders(ElectionType, Set,
ElectLeadersOptions)}.
diff --git
a/clients/src/main/java/org/apache/kafka/clients/admin/ElectPreferredLeadersResult.java
b/clients/src/main/java/org/apache/kafka/clients/admin/ElectPreferredLeadersResult.java
index 0c85193..bf630f3 100644
---
a/clients/src/main/java/org/apache/kafka/clients/admin/ElectPreferredLeadersResult.java
+++
b/clients/src/main/java/org/apache/kafka/clients/admin/ElectPreferredLeadersResult.java
@@ -22,6 +22,8 @@ import java.util.Collection;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
+
+import org.apache.kafka.common.ElectionType;
import org.apache.kafka.common.KafkaFuture;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.annotation.InterfaceStability;
diff --git
a/clients/src/main/java/org/apache/kafka/clients/admin/ListOffsetsOptions.java
b/clients/src/main/java/org/apache/kafka/clients/admin/ListOffsetsOptions.java
index 0e116e2..684ad26 100644
---
a/clients/src/main/java/org/apache/kafka/clients/admin/ListOffsetsOptions.java
+++
b/clients/src/main/java/org/apache/kafka/clients/admin/ListOffsetsOptions.java
@@ -19,6 +19,8 @@ package org.apache.kafka.clients.admin;
import org.apache.kafka.common.IsolationLevel;
import org.apache.kafka.common.annotation.InterfaceStability;
+import java.util.Map;
+
/**
* Options for {@link AdminClient#listOffsets(Map)}.
*
diff --git
a/clients/src/main/java/org/apache/kafka/clients/admin/OffsetSpec.java
b/clients/src/main/java/org/apache/kafka/clients/admin/OffsetSpec.java
index 8955b41..262d264 100644
--- a/clients/src/main/java/org/apache/kafka/clients/admin/OffsetSpec.java
+++ b/clients/src/main/java/org/apache/kafka/clients/admin/OffsetSpec.java
@@ -16,6 +16,7 @@
*/
package org.apache.kafka.clients.admin;
+import java.util.Map;
/**
* This class allows to specify the desired offsets when using {@link
KafkaAdminClient#listOffsets(Map, ListOffsetsOptions)}
diff --git
a/clients/src/main/java/org/apache/kafka/clients/consumer/internals/RequestFuture.java
b/clients/src/main/java/org/apache/kafka/clients/consumer/internals/RequestFuture.java
index 52733ae..8a9d970 100644
---
a/clients/src/main/java/org/apache/kafka/clients/consumer/internals/RequestFuture.java
+++
b/clients/src/main/java/org/apache/kafka/clients/consumer/internals/RequestFuture.java
@@ -18,13 +18,15 @@ package org.apache.kafka.clients.consumer.internals;
import org.apache.kafka.common.errors.RetriableException;
import org.apache.kafka.common.protocol.Errors;
+import org.apache.kafka.common.utils.Timer;
+
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.atomic.AtomicReference;
/**
- * Result of an asynchronous request from {@link ConsumerNetworkClient}. Use
{@link ConsumerNetworkClient#poll(long)}
+ * Result of an asynchronous request from {@link ConsumerNetworkClient}. Use
{@link ConsumerNetworkClient#poll(Timer)}
* (and variants) to finish a request future. Use {@link #isDone()} to check
if the future is complete, and
* {@link #succeeded()} to check if the request completed successfully.
Typical usage might look like this:
*
diff --git
a/clients/src/main/java/org/apache/kafka/common/ClusterResourceListener.java
b/clients/src/main/java/org/apache/kafka/common/ClusterResourceListener.java
index 97245a3..f1939df 100644
--- a/clients/src/main/java/org/apache/kafka/common/ClusterResourceListener.java
+++ b/clients/src/main/java/org/apache/kafka/common/ClusterResourceListener.java
@@ -26,16 +26,16 @@ package org.apache.kafka.common;
* There will be one invocation of {@link
ClusterResourceListener#onUpdate(ClusterResource)} after each metadata response.
* Note that the cluster id may be null when the Kafka broker version is below
0.10.1.0. If you receive a null cluster id, you can expect it to always be null
unless you have a cluster with multiple broker versions which can happen if the
cluster is being upgraded while the client is running.
* <p>
- * {@link org.apache.kafka.clients.producer.ProducerInterceptor} : The {@link
ClusterResourceListener#onUpdate(ClusterResource)} method will be invoked after
{@link
org.apache.kafka.clients.producer.ProducerInterceptor#onSend(ProducerRecord)}
- * but before {@link
org.apache.kafka.clients.producer.ProducerInterceptor#onAcknowledgement(RecordMetadata,
Exception)} .
+ * {@link org.apache.kafka.clients.producer.ProducerInterceptor} : The {@link
ClusterResourceListener#onUpdate(ClusterResource)} method will be invoked after
{@link
org.apache.kafka.clients.producer.ProducerInterceptor#onSend(org.apache.kafka.clients.producer.ProducerRecord)}
+ * but before {@link
org.apache.kafka.clients.producer.ProducerInterceptor#onAcknowledgement(org.apache.kafka.clients.producer.RecordMetadata,
Exception)} .
* <p>
- * {@link org.apache.kafka.clients.consumer.ConsumerInterceptor} : The {@link
ClusterResourceListener#onUpdate(ClusterResource)} method will be invoked
before {@link
org.apache.kafka.clients.consumer.ConsumerInterceptor#onConsume(ConsumerRecords)}
+ * {@link org.apache.kafka.clients.consumer.ConsumerInterceptor} : The {@link
ClusterResourceListener#onUpdate(ClusterResource)} method will be invoked
before {@link
org.apache.kafka.clients.consumer.ConsumerInterceptor#onConsume(org.apache.kafka.clients.consumer.ConsumerRecords)}
* <p>
* {@link org.apache.kafka.common.serialization.Serializer} : The {@link
ClusterResourceListener#onUpdate(ClusterResource)} method will be invoked
before {@link
org.apache.kafka.common.serialization.Serializer#serialize(String, Object)}
* <p>
* {@link org.apache.kafka.common.serialization.Deserializer} : The {@link
ClusterResourceListener#onUpdate(ClusterResource)} method will be invoked
before {@link
org.apache.kafka.common.serialization.Deserializer#deserialize(String, byte[])}
* <p>
- * {@link org.apache.kafka.common.metrics.MetricsReporter} : The {@link
ClusterResourceListener#onUpdate(ClusterResource)} method will be invoked after
first {@link
org.apache.kafka.clients.producer.KafkaProducer#send(ProducerRecord)}
invocation for Producer metrics reporter
+ * {@link org.apache.kafka.common.metrics.MetricsReporter} : The {@link
ClusterResourceListener#onUpdate(ClusterResource)} method will be invoked after
first {@link
org.apache.kafka.clients.producer.KafkaProducer#send(org.apache.kafka.clients.producer.ProducerRecord)}
invocation for Producer metrics reporter
* and after first {@link
org.apache.kafka.clients.consumer.KafkaConsumer#poll(java.time.Duration)}
invocation for Consumer metrics
* reporters. The reporter may receive metric events from the network layer
before this method is invoked.
* <h4>Broker</h4>
diff --git a/clients/src/main/java/org/apache/kafka/common/ElectionType.java
b/clients/src/main/java/org/apache/kafka/common/ElectionType.java
index 4e29853..55331c5 100644
--- a/clients/src/main/java/org/apache/kafka/common/ElectionType.java
+++ b/clients/src/main/java/org/apache/kafka/common/ElectionType.java
@@ -17,11 +17,13 @@
package org.apache.kafka.common;
-import java.util.Arrays;
import org.apache.kafka.common.annotation.InterfaceStability;
+import java.util.Arrays;
+import java.util.Set;
+
/**
- * Options for {@link
org.apache.kafka.clients.admin.Admin#electLeaders(ElectionType, Set,
ElectLeadersOptions)}.
+ * Options for {@link
org.apache.kafka.clients.admin.Admin#electLeaders(ElectionType, Set,
org.apache.kafka.clients.admin.ElectLeadersOptions)}.
*
* The API of this class is evolving, see {@link
org.apache.kafka.clients.admin.Admin} for details.
*/
diff --git
a/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java
b/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java
index e18ba8f..93ab2bd 100644
--- a/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java
+++ b/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java
@@ -123,7 +123,7 @@ public abstract class SourceTask implements Task {
* in their own system.
* </p>
* <p>
- * The default implementation just calls @{link
commitRecord(SourceRecord)}, which is a nop by default. It is
+ * The default implementation just calls {@link
#commitRecord(SourceRecord)}, which is a nop by default. It is
* not necessary to implement both methods.
* </p>
*
diff --git
a/streams/src/test/java/org/apache/kafka/streams/integration/utils/IntegrationTestUtils.java
b/streams/src/test/java/org/apache/kafka/streams/integration/utils/IntegrationTestUtils.java
index 42d203c..6c88e68 100644
---
a/streams/src/test/java/org/apache/kafka/streams/integration/utils/IntegrationTestUtils.java
+++
b/streams/src/test/java/org/apache/kafka/streams/integration/utils/IntegrationTestUtils.java
@@ -747,7 +747,7 @@ public class IntegrationTestUtils {
* {@link State#RUNNING} state at the same time. Note that states may
change between the time
* that this method returns and the calling function executes its next
statement.<p>
*
- * When the application is already started use {@link
#waitForApplicationState(List, Duration)}
+ * When the application is already started use {@link
#waitForApplicationState(List, State, Duration)}
* to wait for instances to reach {@link State#RUNNING} state.
*
* @param streamsList the list of streams instances to run.
