This is an automated email from the ASF dual-hosted git repository.
eolivelli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 6826434 [Java Client] Fix JavaDoc for closeAsync: remove documented
exception that isn't thrown (#12005)
6826434 is described below
commit 6826434df96605437d3be90599f98a93036e334b
Author: Michael Marshall <[email protected]>
AuthorDate: Mon Oct 4 01:19:58 2021 -0500
[Java Client] Fix JavaDoc for closeAsync: remove documented exception that
isn't thrown (#12005)
---
.../src/main/java/org/apache/pulsar/client/api/PulsarClient.java | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git
a/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/PulsarClient.java
b/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/PulsarClient.java
index 5f1a18b..91cdc3a 100644
---
a/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/PulsarClient.java
+++
b/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/PulsarClient.java
@@ -272,8 +272,7 @@ public interface PulsarClient extends Closeable {
* this client has currently active. That implies that close and wait,
asynchronously, until all pending producer
* send requests are persisted.
*
- * @throws PulsarClientException
- * if the close operation fails
+ * @return a future that can be used to track the completion of the
operation
*/
CompletableFuture<Void> closeAsync();