Skip to content

Cleanup/javadoc #407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 20, 2020
Merged

Cleanup/javadoc #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe98ec5
Improved javadoc
SgtSilvio Apr 17, 2020
877250a
Fixed javadoc character escaping
SgtSilvio Apr 17, 2020
c7e9900
Small javadoc improvements
SgtSilvio Apr 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 52 additions & 53 deletions reactor/src/main/java/com/hivemq/client/mqtt/mqtt3/reactor/Mqtt3ReactorClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
import reactor.core.publisher.Mono;

/**
* Reactor API of a {@link Mqtt3Client}.
* Reactor API of an {@link Mqtt3Client}.
*
* @author Silvio Giebl
* @since 1.2
Expand Down Expand Up @@ -81,12 +81,11 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
* @param connect the Connect message sent to the broker during connect.
* @return the {@link Mono} which
* <ul>
* <li>succeeds with the ConnAck message if it does not contain an Error Code (connected
* successfully),</li>
* <li>errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException
* Mqtt3ConnAckException} wrapping the ConnAck message if it contains an Error Code or</li>
* <li>errors with a different exception if an error occurred before the Connect message was sent or before
* the ConnAck message was received.</li>
* <li>succeeds with the ConnAck message if it does not contain an Error Code (connected successfully),
* <li>errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException
* Mqtt3ConnAckException} wrapping the ConnAck message if it contains an Error Code or
* <li>errors with a different exception if an error occurred before the Connect message was sent or
* before the ConnAck message was received.
* </ul>
*/
@CheckReturnValue
Expand Down Expand Up @@ -118,12 +117,12 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
* @param subscribe the Subscribe message sent to the broker during subscribe.
* @return the {@link Mono} which
* <ul>
* <li>succeeds with the SubAck message if at least one subscription of the Subscribe message was
* successful (the SubAck message contains at least one Return Code that is not an Error Code),</li>
* <li>errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException
* Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or</li>
* <li>errors with a different exception if an error occurred before the Subscribe message was sent or
* before a SubAck message was received.</li>
* <li>succeeds with the SubAck message if at least one subscription of the Subscribe message was
* successful (the SubAck message contains at least one Return Code that is not an Error Code),
* <li>errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException
* Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or
* <li>errors with a different exception if an error occurred before the Subscribe message was sent or
* before a SubAck message was received.
* </ul>
*/
@CheckReturnValue
Expand Down Expand Up @@ -153,17 +152,17 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
* @param subscribe the Subscribe message sent to the broker during subscribe.
* @return the {@link FluxWithSingle} which
* <ul>
* <li>emits the SubAck message as the single and first element if at least one subscription of the
* Subscribe message was successful (the SubAck message contains at least one Return Code that is not an
* Error Code) and then emits the Publish messages matching the successful subscriptions of the Subscribe
* message,</li>
* <li>completes when all subscriptions of the Subscribe message were unsubscribed,</li>
* <li>errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException
* Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or</li>
* <li>errors with a different exception if an error occurred before the Subscribe message was sent,
* before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe
* message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException
* MqttSessionExpiredException}).</li>
* <li>emits the SubAck message as the single and first element if at least one subscription of the
* Subscribe message was successful (the SubAck message contains at least one Return Code that is not an
* Error Code) and then emits the Publish messages matching the successful subscriptions of the
* Subscribe message,
* <li>completes when all subscriptions of the Subscribe message were unsubscribed,
* <li>errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException
* Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or
* <li>errors with a different exception if an error occurred before the Subscribe message was sent,
* before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe
* message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException
* MqttSessionExpiredException}).
* </ul>
* @see #subscribePublishes(Mqtt3Subscribe, boolean)
*/
Expand All @@ -182,17 +181,17 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
* @param manualAcknowledgement whether the Publish messages are acknowledged manually.
* @return the {@link FluxWithSingle} which
* <ul>
* <li>emits the SubAck message as the single and first element if at least one subscription of the
* Subscribe message was successful (the SubAck message contains at least one Return Code that is not an
* Error Code) and then emits the Publish messages matching the successful subscriptions of the Subscribe
* message,</li>
* <li>completes when all subscriptions of the Subscribe message were unsubscribed,</li>
* <li>errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException
* Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or</li>
* <li>errors with a different exception if an error occurred before the Subscribe message was sent,
* before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe
* message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException
* MqttSessionExpiredException}).</li>
* <li>emits the SubAck message as the single and first element if at least one subscription of the
* Subscribe message was successful (the SubAck message contains at least one Return Code that is not an
* Error Code) and then emits the Publish messages matching the successful subscriptions of the
* Subscribe message,
* <li>completes when all subscriptions of the Subscribe message were unsubscribed,
* <li>errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException
* Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or
* <li>errors with a different exception if an error occurred before the Subscribe message was sent,
* before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe
* message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException
* MqttSessionExpiredException}).
* </ul>
* @see #subscribePublishes(Mqtt3Subscribe)
*/
Expand Down Expand Up @@ -223,10 +222,10 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
* @param filter the filter with which all incoming Publish messages are filtered.
* @return the {@link Flux} which
* <ul>
* <li>emits the incoming Publish messages matching the given filter,</li>
* <li>never completes but</li>
* <li>errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException
* MqttSessionExpiredException} when the MQTT session expires.</li>
* <li>emits the incoming Publish messages matching the given filter,
* <li>never completes but
* <li>errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException
* MqttSessionExpiredException} when the MQTT session expires.
* </ul>
* @see #publishes(MqttGlobalPublishFilter, boolean)
*/
Expand All @@ -244,10 +243,10 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
* @param manualAcknowledgement whether the Publish messages are acknowledged manually.
* @return the {@link Flux} which
* <ul>
* <li>emits the incoming Publish messages matching the given filter,</li>
* <li>never completes but</li>
* <li>errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException
* MqttSessionExpiredException} when the MQTT session expires.</li>
* <li>emits the incoming Publish messages matching the given filter,
* <li>never completes but
* <li>errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException
* MqttSessionExpiredException} when the MQTT session expires.
* </ul>
* @see #publishes(MqttGlobalPublishFilter)
*/
Expand All @@ -264,9 +263,9 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
* @param unsubscribe the Unsubscribe message sent to the broker during unsubscribe.
* @return the {@link Mono} which
* <ul>
* <li>succeeds when the corresponding UnsubAck message was received or</li>
* <li>errors if an error occurred before the Unsubscribe message was sent or before a UnsubAck message was
* received.</li>
* <li>succeeds when the corresponding UnsubAck message was received or
* <li>errors if an error occurred before the Unsubscribe message was sent or before a UnsubAck message
* was received.
* </ul>
*/
@CheckReturnValue
Expand Down Expand Up @@ -296,11 +295,11 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
* @param publisher the source of the Publish messages to publish.
* @return the {@link Flux} which
* <ul>
* <li>emits {@link Mqtt3PublishResult}s each corresponding to a Publish message,</li>
* <li>completes if the given {@link Publisher} completes, but not before all {@link Mqtt3PublishResult}s
* were emitted, or</li>
* <li>errors with the same exception if the given {@link Publisher} errors, but not before all
* {@link Mqtt3PublishResult}s were emitted.</li>
* <li>emits {@link Mqtt3PublishResult}s each corresponding to a Publish message,
* <li>completes if the given {@link Publisher} completes, but not before all {@link Mqtt3PublishResult}s
* were emitted, or
* <li>errors with the same exception if the given {@link Publisher} errors, but not before all
* {@link Mqtt3PublishResult}s were emitted.
* </ul>
*/
@CheckReturnValue
Expand All @@ -314,8 +313,8 @@ public interface Mqtt3ReactorClient extends Mqtt3Client {
*
* @return the {@link Mono} which
* <ul>
* <li>completes when the client was successfully disconnected or</li>
* <li>errors if not disconnected gracefully.</li>
* <li>completes when the client was successfully disconnected or
* <li>errors if not disconnected gracefully.
* </ul>
*/
@CheckReturnValue
Expand Down
Loading