From da79cb43e873f7cf0a0f1dfec0d2e83e40dfa524 Mon Sep 17 00:00:00 2001
From: flyisland <flyisland@gmail.com>
Date: Tue, 30 Mar 2021 09:02:39 +0800
Subject: [PATCH] docs: add commend for method
 ConfigObject.checkAttributeCombinations().

---
 .../solace/tools/sempcfg/model/ConfigObject.java    | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/main/java/com/solace/tools/sempcfg/model/ConfigObject.java b/src/main/java/com/solace/tools/sempcfg/model/ConfigObject.java
index 37e5406..08558f0 100644
--- a/src/main/java/com/solace/tools/sempcfg/model/ConfigObject.java
+++ b/src/main/java/com/solace/tools/sempcfg/model/ConfigObject.java
@@ -190,6 +190,19 @@ public void removeAttributesWithDefaultValue() {
         forEachChild(ConfigObject::removeAttributesWithDefaultValue);
     }
 
+    /**
+     * For example, below is the description of POST action of URI: /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers,
+     * means that if attribute `remotePort` is present in the payload, then attribute `tlsEnabled` is required in the payload too.
+     *
+     *| Class                               | Attribute                        | Requires                        | Conflicts |
+     * | :---------------------------------- | :------------------------------- | :------------------------------ | :-------- |
+     * | MsgVpnRestDeliveryPointRestConsumer | authenticationClientCertPassword | authenticationClientCertContent |
+     * | MsgVpnRestDeliveryPointRestConsumer | authenticationHttpBasicPassword  | authenticationHttpBasicUsername |
+     * | MsgVpnRestDeliveryPointRestConsumer | authenticationHttpBasicUsername  | authenticationHttpBasicPassword |
+     * | MsgVpnRestDeliveryPointRestConsumer | remotePort                       | tlsEnabled                      |
+     * | MsgVpnRestDeliveryPointRestConsumer | tlsEnabled                       | remotePort                      |
+     */
+
     public void checkAttributeCombinations() {
         var requiresAttributesWithDefalutValue = sempSpec.getRequiresAttributeWithDefaultValue(attributes.keySet());
         attributes.putAll(requiresAttributesWithDefalutValue);