You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2022/09/01 12:40:13 UTC
[plc4x] 01/02: doc(plc4): refined java doc regarding subscription
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
commit 119bcf84871a484afa31628fabf1017ab7d8b0b6
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Thu Sep 1 13:28:43 2022 +0200
doc(plc4): refined java doc regarding subscription
---
.../plc4x/java/api/messages/PlcSubscriptionResponse.java | 9 +++++++++
.../java/api/messages/PlcUnsubscriptionRequest.java | 16 +++++++++++++---
2 files changed, 22 insertions(+), 3 deletions(-)
diff --git a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcSubscriptionResponse.java b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcSubscriptionResponse.java
index 90ca60825..a83ffaeaf 100644
--- a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcSubscriptionResponse.java
+++ b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcSubscriptionResponse.java
@@ -27,8 +27,17 @@ public interface PlcSubscriptionResponse extends PlcSubscriptionFieldResponse {
@Override
PlcSubscriptionRequest getRequest();
+ /**
+ * Returns a {@link PlcSubscriptionHandle} associated with a {@code name} from {@link PlcSubscriptionRequest#getField(String)}
+ *
+ * @param name the field name which a {@link PlcSubscriptionHandle} is required to
+ * @return a {@link PlcSubscriptionHandle}
+ */
PlcSubscriptionHandle getSubscriptionHandle(String name);
+ /**
+ * @return all {@link PlcSubscriptionHandle}s
+ */
Collection<PlcSubscriptionHandle> getSubscriptionHandles();
}
diff --git a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcUnsubscriptionRequest.java b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcUnsubscriptionRequest.java
index 56abed3f2..cb4a77856 100644
--- a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcUnsubscriptionRequest.java
+++ b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcUnsubscriptionRequest.java
@@ -37,15 +37,25 @@ public interface PlcUnsubscriptionRequest extends PlcRequest {
PlcUnsubscriptionRequest build();
/**
- * TODO document me:
+ * {@link PlcSubscriptionHandle} that should be removed from the subscription
*
- * @param plcSubscriptionHandle
- * @return
+ * @param plcSubscriptionHandle {@link PlcSubscriptionHandle} to be removed
*/
PlcUnsubscriptionRequest.Builder addHandles(PlcSubscriptionHandle plcSubscriptionHandle);
+ /**
+ * {@link PlcSubscriptionHandle}s that should be removed from the subscription
+ *
+ * @param plcSubscriptionHandle1 {@link PlcSubscriptionHandle} to be removed
+ * @param plcSubscriptionHandles {@link PlcSubscriptionHandle} to be removed
+ */
PlcUnsubscriptionRequest.Builder addHandles(PlcSubscriptionHandle plcSubscriptionHandle1, PlcSubscriptionHandle... plcSubscriptionHandles);
+ /**
+ * {@link PlcSubscriptionHandle}s that should be removed from the subscription
+ *
+ * @param plcSubscriptionHandle {@link PlcSubscriptionHandle} to be removed
+ */
PlcUnsubscriptionRequest.Builder addHandles(Collection<PlcSubscriptionHandle> plcSubscriptionHandle);
}