You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by lh...@apache.org on 2022/12/01 07:49:21 UTC
[pulsar-client-reactive] branch main updated: Fix various javadoc warnings (#57)
This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-client-reactive.git
The following commit(s) were added to refs/heads/main by this push:
new 88bd043 Fix various javadoc warnings (#57)
88bd043 is described below
commit 88bd0430a43a10612fa55e2d479e4bda747e7912
Author: Christophe Bornet <cb...@hotmail.com>
AuthorDate: Thu Dec 1 08:49:16 2022 +0100
Fix various javadoc warnings (#57)
---
.../pulsar/reactive/client/api/EndOfStreamAction.java | 5 +++++
.../client/api/ImmutableReactiveMessageConsumerSpec.java | 5 +++++
.../client/api/ImmutableReactiveMessageReaderSpec.java | 5 +++++
.../client/api/ImmutableReactiveMessageSenderSpec.java | 5 +++++
.../pulsar/reactive/client/api/InstantStartAtSpec.java | 8 ++++++++
.../pulsar/reactive/client/api/MessageIdStartAtSpec.java | 13 +++++++++++++
.../pulsar/reactive/client/api/MessageSpecBuilder.java | 4 ++++
.../reactive/client/api/ReactiveMessageConsumerBuilder.java | 1 -
8 files changed, 45 insertions(+), 1 deletion(-)
diff --git a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/EndOfStreamAction.java b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/EndOfStreamAction.java
index 09ccd3d..d9c4989 100644
--- a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/EndOfStreamAction.java
+++ b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/EndOfStreamAction.java
@@ -16,6 +16,11 @@
package org.apache.pulsar.reactive.client.api;
+/**
+ * Action to perform once the end of the stream is reached.
+ *
+ * @author Lari Hotari
+ */
public enum EndOfStreamAction {
/** Complete at end of stream. */
diff --git a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageConsumerSpec.java b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageConsumerSpec.java
index cfc23b7..cd49950 100644
--- a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageConsumerSpec.java
+++ b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageConsumerSpec.java
@@ -107,6 +107,11 @@ public class ImmutableReactiveMessageConsumerSpec implements ReactiveMessageCons
private final Duration expireTimeOfIncompleteChunkedMessage;
+ /**
+ * Constructs a ImmutableReactiveMessageConsumerSpec from another
+ * {@link ReactiveMessageConsumerSpec}.
+ * @param consumerSpec the spec to construct from
+ */
public ImmutableReactiveMessageConsumerSpec(ReactiveMessageConsumerSpec consumerSpec) {
this.topicNames = (consumerSpec.getTopicNames() != null && !consumerSpec.getTopicNames().isEmpty())
? Collections.unmodifiableList(new ArrayList<>(consumerSpec.getTopicNames())) : null;
diff --git a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageReaderSpec.java b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageReaderSpec.java
index 068eed7..2719afd 100644
--- a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageReaderSpec.java
+++ b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageReaderSpec.java
@@ -64,6 +64,11 @@ public class ImmutableReactiveMessageReaderSpec implements ReactiveMessageReader
this.cryptoFailureAction = cryptoFailureAction;
}
+ /**
+ * Constructs a ImmutableReactiveMessageConsumerSpec from another
+ * {@link ReactiveMessageConsumerSpec}.
+ * @param readerSpec the spec to construct from
+ */
public ImmutableReactiveMessageReaderSpec(ReactiveMessageReaderSpec readerSpec) {
this.topicNames = (readerSpec.getTopicNames() != null && !readerSpec.getTopicNames().isEmpty())
? Collections.unmodifiableList(new ArrayList<>(readerSpec.getTopicNames())) : null;
diff --git a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageSenderSpec.java b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageSenderSpec.java
index 5e49a94..2693961 100644
--- a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageSenderSpec.java
+++ b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ImmutableReactiveMessageSenderSpec.java
@@ -129,6 +129,11 @@ public class ImmutableReactiveMessageSenderSpec implements ReactiveMessageSender
this.properties = properties;
}
+ /**
+ * Constructs a ImmutableReactiveMessageConsumerSpec from another
+ * {@link ReactiveMessageConsumerSpec}.
+ * @param senderSpec the spec to construct from
+ */
public ImmutableReactiveMessageSenderSpec(ReactiveMessageSenderSpec senderSpec) {
this.topicName = senderSpec.getTopicName();
this.producerName = senderSpec.getProducerName();
diff --git a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/InstantStartAtSpec.java b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/InstantStartAtSpec.java
index 8ec3097..c72f5bc 100644
--- a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/InstantStartAtSpec.java
+++ b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/InstantStartAtSpec.java
@@ -28,10 +28,18 @@ public final class InstantStartAtSpec extends StartAtSpec {
private final Instant instant;
+ /**
+ * Constructs a {@link InstantStartAtSpec}.
+ * @param instant the instant in time from when to start reading from
+ */
public InstantStartAtSpec(final Instant instant) {
this.instant = instant;
}
+ /**
+ * Gets the instant from when to start reading from.
+ * @return the instant in time from when to start reading from
+ */
public Instant getInstant() {
return this.instant;
}
diff --git a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/MessageIdStartAtSpec.java b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/MessageIdStartAtSpec.java
index 4548cf9..dd1ae89 100644
--- a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/MessageIdStartAtSpec.java
+++ b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/MessageIdStartAtSpec.java
@@ -31,15 +31,28 @@ public final class MessageIdStartAtSpec extends StartAtSpec {
private final boolean inclusive;
+ /**
+ * Contructs a {@link MessageIdStartAtSpec}.
+ * @param messageId the message id from which to start reading from
+ * @param inclusive true to include the message with the message id
+ */
public MessageIdStartAtSpec(final MessageId messageId, final boolean inclusive) {
this.messageId = messageId;
this.inclusive = inclusive;
}
+ /**
+ * Gets the message id from which to start reading from.
+ * @return the message id from which to start reading from
+ */
public MessageId getMessageId() {
return this.messageId;
}
+ /**
+ * Gets whether the message with the message id must be included.
+ * @return true if the message with the message id must be included
+ */
public boolean isInclusive() {
return this.inclusive;
}
diff --git a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/MessageSpecBuilder.java b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/MessageSpecBuilder.java
index 13c03c5..01c38b1 100644
--- a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/MessageSpecBuilder.java
+++ b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/MessageSpecBuilder.java
@@ -153,6 +153,10 @@ public interface MessageSpecBuilder<T> {
*/
MessageSpecBuilder<T> deliverAfter(long delay, TimeUnit unit);
+ /**
+ * Builds the {@link MessageSpec}.
+ * @return the built message spec
+ */
MessageSpec<T> build();
}
diff --git a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ReactiveMessageConsumerBuilder.java b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ReactiveMessageConsumerBuilder.java
index 444960d..cc6f151 100644
--- a/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ReactiveMessageConsumerBuilder.java
+++ b/pulsar-client-reactive-api/src/main/java/org/apache/pulsar/reactive/client/api/ReactiveMessageConsumerBuilder.java
@@ -358,7 +358,6 @@ public interface ReactiveMessageConsumerBuilder<T> {
* priorityLevel 1 then the broker will dispatch messages only to consumer-A until it
* runs out of permits, then the broker will start dispatching messages to consumer-B.
*
- * <p>
* <pre>
* Consumer PriorityLevel Permits
* C1 0 2