From e9c786ce493053ddb188cea242f942bb5f91d56f Mon Sep 17 00:00:00 2001
From: Jan Zickermann <jan.zickermann@dataport.de>
Date: Tue, 22 Oct 2024 12:54:37 +0200
Subject: [PATCH] OZG-6891 KOP-2735 javadoc: Explain xta client
---
src/main/java/de/ozgcloud/xta/client/XtaClient.java | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/de/ozgcloud/xta/client/XtaClient.java b/src/main/java/de/ozgcloud/xta/client/XtaClient.java
index 63f0164..c5c7492 100644
--- a/src/main/java/de/ozgcloud/xta/client/XtaClient.java
+++ b/src/main/java/de/ozgcloud/xta/client/XtaClient.java
@@ -84,8 +84,8 @@ public class XtaClient {
* </p>
*
* @param processMessage The consumer to process each fetched message.
- * @return The transport reports for all fetched/processed messages. Messages which have not been closed have an
- * {@link XtaMessageStatus#OPEN OPEN} status. If the message has been closed the status is {@link XtaMessageStatus#GREEN GREEN},
+ * @return The transport reports for all fetched/processed messages. A message which has not been closed has an
+ * {@link XtaMessageStatus#OPEN OPEN} status. If a message has been closed, the status is either {@link XtaMessageStatus#GREEN GREEN},
* {@link XtaMessageStatus#YELLOW YELLOW} or {@link XtaMessageStatus#RED RED}.
* @throws XtaClientException If a technical problem occurs while fetching messages.
*/
@@ -204,8 +204,8 @@ public class XtaClient {
* </p>
*
* @param messageWithoutMessageId The message to send without id and size.
- * @return The transport report for the sent message. An {@link XtaMessageStatus#OPEN} status indicates that the message was sent with no error or
- * warning. Moreover, the report contains the message metadata, including id and size values set by the server.
+ * @return The transport report for the sent message. As long as the reader did not read the message the status is {@link XtaMessageStatus#OPEN}.
+ * Moreover, the report contains the message metadata, including id and size values set by the server.
* @throws XtaClientException If a check fails or a technical problem occurs while sending the message.
*/
public XtaTransportReport sendMessage(@NotNull @Valid XtaMessage messageWithoutMessageId) throws XtaClientException {
--
GitLab