PR Review based modification

- remove unwanted disabled tag on test
- add best and since tag on java doc to all public api
- code reduction on createPatchObjectRecursiveDelta
- generalize containsNestedChangedFields with type validation
- comment correction

Author: rpanackal

datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/request/UpdateStrategy.java

@@ -3,6 +3,8 @@
  */
 package com.sap.cloud.sdk.datamodel.odata.client.request;
 
+import com.google.common.annotations.Beta;
+
 /**
  * The strategy to use when updating existing entities.
  */
@@ -21,18 +23,24 @@ public enum UpdateStrategy
 
     /**
      * Request to update the entity is sent with the HTTP method PATCH and its payload contains the changed fields
-     * including the changes in nested fields.
+     * including the changes in nested non-entity type fields.
      *
      * The request payload contains only the changed fields. Navigation properties are not supported.
+     *
+     * @since 5.16.0
      */
+    @Beta
     MODIFY_WITH_PATCH_RECURSIVE_DELTA,
 
     /**
      * Request to update the entity is sent with the HTTP method PATCH and its payload contains the changed fields
-     * including the changes in nested fields.
+     * including the changes in nested non-entity type fields.
      *
      * The request payload contains the full value of complex fields for changes in any nested field. Navigation
      * properties are not supported.
+     *
+     * @since 5.16.0
      */
+    @Beta
     MODIFY_WITH_PATCH_RECURSIVE_FULL;
 }

datamodel/odata/odata-api-sample/src/test/java/com/sap/cloud/sdk/datamodel/odata/helper/FluentHelperUpdateToRequestTest.java

@@ -20,7 +20,6 @@
 import org.apache.http.HttpVersion;
 import org.apache.http.client.HttpClient;
 import org.apache.http.message.BasicHttpResponse;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination;
@@ -254,7 +253,6 @@ void testUpdatePatchComplexPropertyFull()
     }
 
     @Test
-    @Disabled( " Test is failing as the getChangedFields() method on Complex Type is not working as expected." )
     void testIgnoreVersionIdentifier()
     {
         product.setVersionIdentifier(versionIdentifier);

datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/FluentHelperUpdate.java

@@ -14,6 +14,7 @@
 
 import org.apache.http.client.HttpClient;
 
+import com.google.common.annotations.Beta;
 import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
 import com.sap.cloud.sdk.cloudplatform.connectivity.HttpClientAccessor;
 import com.sap.cloud.sdk.datamodel.odata.client.ODataProtocol;
@@ -271,7 +272,9 @@ public final FluentHelperT modifyingEntity()
      * @return The same fluent helper which will modify the entity in the remote system.
      * @throws IllegalArgumentException
      *             If an unknown ModifyPatchStrategy is provided.
+     * @since 5.16.0
      */
+    @Beta
     @Nonnull
     public final FluentHelperT modifyingEntity( @Nonnull final ModifyPatchStrategy strategy )
     {

datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/ModifyPatchStrategy.java

@@ -1,8 +1,13 @@
 package com.sap.cloud.sdk.datamodel.odata.helper;
 
+import com.google.common.annotations.Beta;
+
 /**
  * Strategy to determine how a patch operation should be applied to an entity.
+ *
+ * @since 5.16.0
  */
+@Beta
 public enum ModifyPatchStrategy
 {
     /** Only the top level fields can be patched */

datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/ODataEntitySerializer.java

@@ -9,7 +9,6 @@
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.List;
-import java.util.Map;
 import java.util.Set;
 import java.util.function.BiConsumer;
 import java.util.function.BiPredicate;
@@ -150,8 +149,7 @@ static String serializeEntityForUpdatePatchRecursiveFull(
             .entrySet()
             .stream()
             .filter(entry -> !patchObject.has(entry.getKey()))
-            .filter(entry -> entry.getValue() instanceof VdmComplex<?>)
-            .filter(entry -> containsNestedChangedFields((VdmComplex<?>) entry.getValue()))
+            .filter(entry -> containsNestedChangedFields(entry.getValue()))
             .forEach(entry -> patchObject.add(entry.getKey(), fullEntityJson.get(entry.getKey())));
 
         log.debug("The following object is serialized for update : {}.", patchObject);
@@ -162,23 +160,23 @@ static String serializeEntityForUpdatePatchRecursiveFull(
     /**
      * Checks if the given complex object contains any changed fields in its nested fields.
      *
-     * @param vdmComplex
+     * @param obj
      *            the complex object to check
      * @return true if the complex object contains any changed fields, false otherwise
      */
-    private static boolean containsNestedChangedFields( final VdmComplex<?> vdmComplex )
+    private static boolean containsNestedChangedFields( final Object obj )
     {
-        if( !vdmComplex.getChangedFields().isEmpty() ) {
-            return true;
+        if( obj instanceof VdmComplex<?> vdmComplex ) {
+            if( !vdmComplex.getChangedFields().isEmpty() ) {
+                return true;
+            }
+            for( Object complexField : vdmComplex.toMapOfFields().values() ) {
+                if( containsNestedChangedFields(complexField) ) {
+                    return true;
+                }
+            }
         }
-
-        return vdmComplex
-            .toMapOfFields()
-            .values()
-            .stream()
-            .filter(complexField -> complexField instanceof VdmComplex<?>)
-            .map(complexField -> (VdmComplex<?>) complexField)
-            .anyMatch(ODataEntitySerializer::containsNestedChangedFields);
+        return false;
     }
 
     /**
@@ -237,24 +235,18 @@ static String serializeEntityForUpdatePatchRecursiveDelta(
     {
         final JsonObject patch = new JsonObject();
 
-        // Process all complex fields
-        vdmObject
-            .toMapOfFields()
-            .entrySet()
-            .stream()
-            .filter(entry -> entry.getValue() instanceof VdmComplex<?>)
-            .map(entry -> {
-                final String fieldName = entry.getKey();
-                final VdmComplex<?> complexField = (VdmComplex<?>) entry.getValue();
-                // Recursively build patch for the complex field
-                final JsonObject childJsonObject =
-                    createPatchObjectRecursiveDelta(complexField, jsonObject.getAsJsonObject(fieldName));
-                return Map.entry(fieldName, childJsonObject);
-            })
-            .filter(entry -> !entry.getValue().isEmpty())
-            .forEach(entry -> patch.add(entry.getKey(), entry.getValue()));
-
-        // Add changed primitive fields
+        // Process all complex fields and recursively build patch for the complex field
+        vdmObject.toMapOfFields().forEach(( fieldName, val ) -> {
+            if( val instanceof VdmComplex<?> complexField ) {
+                final var childJsonObject = jsonObject.getAsJsonObject(fieldName);
+                final var childJsonObjectDelta = createPatchObjectRecursiveDelta(complexField, childJsonObject);
+                if( !childJsonObjectDelta.isEmpty() ) {
+                    patch.add(fieldName, childJsonObjectDelta);
+                }
+            }
+        });
+
+        // Add explicitly changed fields
         vdmObject.getChangedFields().keySet().forEach(key -> patch.add(key, jsonObject.get(key)));
 
         return patch;