typed ArangoCollection#replaceDocuments

Author: rashtao

src/main/java/com/arangodb/ArangoCollection.java

@@ -93,9 +93,6 @@ public interface ArangoCollection extends ArangoSerdeAccessor {
     /**
      * Creates new documents from the given documents, unless there is already a document with the _key given. If no
      * _key is given, a new unique _key is generated automatically.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
      * @return information about the documents
@@ -108,9 +105,6 @@ public interface ArangoCollection extends ArangoSerdeAccessor {
     /**
      * Creates new documents from the given documents, unless there is already a document with the _key given. If no
      * _key is given, a new unique _key is generated automatically.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values  A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
      * @param options Additional options, can be null
@@ -125,9 +119,6 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
     /**
      * Creates new documents from the given documents, unless there is already a document with the _key given. If no
      * _key is given, a new unique _key is generated automatically.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values  A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
      * @param options Additional options, can be null
@@ -142,9 +133,6 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
 
     /**
      * Bulk imports the given values into the collection.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values a list of Objects that will be stored as documents
      * @return information about the import
@@ -154,9 +142,6 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
 
     /**
      * Bulk imports the given values into the collection.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values  a list of Objects that will be stored as documents
      * @param options Additional options, can be null
@@ -167,9 +152,6 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
 
     /**
      * Bulk imports the given values into the collection.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values JSON-encoded array of objects that will be stored as documents
      * @return information about the import
@@ -179,9 +161,6 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
 
     /**
      * Bulk imports the given values into the collection.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values  JSON-encoded array of objects that will be stored as documents
      * @param options Additional options, can be null
@@ -284,24 +263,18 @@ <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplace
     /**
      * Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
      * specified by the _key attributes in the documents in values.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
      * @return information about the documents
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
      * Documentation</a>
      */
-    <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values) throws ArangoDBException;
+    MultiDocumentEntity<DocumentUpdateEntity<Void>> replaceDocuments(Collection<?> values) throws ArangoDBException;
 
     /**
      * Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
      * specified by the _key attributes in the documents in values.
-     * <p>
-     * Limitations:
-     * - the fields having {@code null} value are always removed during serialization
      *
      * @param values  A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
      * @param options Additional options, can be null
@@ -313,6 +286,21 @@ <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplace
     <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(
             Collection<T> values, DocumentReplaceOptions options) throws ArangoDBException;
 
+    /**
+     * Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
+     * specified by the _key attributes in the documents in values.
+     *
+     * @param values  A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
+     * @param options Additional options, can be null
+     * @param type  Deserialization target type for the returned documents.
+     * @return information about the documents
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
+     * Documentation</a>
+     */
+    <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(
+            Collection<T> values, DocumentReplaceOptions options, Class<T> type) throws ArangoDBException;
+
     /**
      * Partially updates the document identified by document-key. The value must contain a document with the attributes
      * to patch (the patch document). All attributes from the patch document will be added to the existing document if

src/main/java/com/arangodb/async/ArangoCollectionAsync.java

@@ -266,7 +266,7 @@ <T> CompletableFuture<DocumentUpdateEntity<T>> replaceDocument(
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
      * Documentation</a>
      */
-    <T> CompletableFuture<MultiDocumentEntity<DocumentUpdateEntity<T>>> replaceDocuments(final Collection<T> values);
+    CompletableFuture<MultiDocumentEntity<DocumentUpdateEntity<Void>>> replaceDocuments(final Collection<?> values);
 
     /**
      * Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
@@ -282,6 +282,22 @@ <T> CompletableFuture<MultiDocumentEntity<DocumentUpdateEntity<T>>> replaceDocum
             final Collection<T> values,
             final DocumentReplaceOptions options);
 
+    /**
+     * Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
+     * specified by the _key attributes in the documents in values.
+     *
+     * @param values  A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
+     * @param options Additional options, can be null
+     * @param type  Deserialization target type for the returned documents.
+     * @return information about the documents
+     * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
+     * Documentation</a>
+     */
+    <T> CompletableFuture<MultiDocumentEntity<DocumentUpdateEntity<T>>> replaceDocuments(
+            final Collection<T> values,
+            final DocumentReplaceOptions options,
+            final Class<T> type);
+
     /**
      * Partially updates the document identified by document-key. The value must contain a document with the attributes
      * to patch (the patch document). All attributes from the patch document will be added to the existing document if

src/main/java/com/arangodb/async/internal/ArangoCollectionAsyncImpl.java

@@ -165,20 +165,22 @@ public <T> CompletableFuture<DocumentUpdateEntity<T>> replaceDocument(String key
     }
 
     @Override
-    public <T> CompletableFuture<MultiDocumentEntity<DocumentUpdateEntity<T>>> replaceDocuments(
-            final Collection<T> values) {
-        final DocumentReplaceOptions params = new DocumentReplaceOptions();
-        return executor.execute(replaceDocumentsRequest(values, params),
-                replaceDocumentsResponseDeserializer(values));
+    public CompletableFuture<MultiDocumentEntity<DocumentUpdateEntity<Void>>> replaceDocuments(
+            final Collection<?> values) {
+        return executor.execute(replaceDocumentsRequest(values, new DocumentReplaceOptions()), replaceDocumentsResponseDeserializer(Void.class));
     }
 
     @Override
+    @SuppressWarnings("unchecked")
     public <T> CompletableFuture<MultiDocumentEntity<DocumentUpdateEntity<T>>> replaceDocuments(
             final Collection<T> values,
             final DocumentReplaceOptions options) {
-        final DocumentReplaceOptions params = (options != null ? options : new DocumentReplaceOptions());
-        return executor.execute(replaceDocumentsRequest(values, params),
-                replaceDocumentsResponseDeserializer(values));
+        return replaceDocuments(values, options, (Class<T>) getCollectionContentClass(values));
+    }
+
+    @Override
+    public <T> CompletableFuture<MultiDocumentEntity<DocumentUpdateEntity<T>>> replaceDocuments(Collection<T> values, DocumentReplaceOptions options, Class<T> type) {
+        return executor.execute(replaceDocumentsRequest(values, options), replaceDocumentsResponseDeserializer(type));
     }
 
     @Override

src/main/java/com/arangodb/internal/ArangoCollectionImpl.java

@@ -168,17 +168,21 @@ public <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, Document
     }
 
     @Override
-    public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(final Collection<T> values)
+    public MultiDocumentEntity<DocumentUpdateEntity<Void>> replaceDocuments(final Collection<?> values)
             throws ArangoDBException {
-        return replaceDocuments(values, new DocumentReplaceOptions());
+        return executor.execute(replaceDocumentsRequest(values, new DocumentReplaceOptions()), replaceDocumentsResponseDeserializer(Void.class));
     }
 
     @Override
+    @SuppressWarnings("unchecked")
     public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(
             final Collection<T> values, final DocumentReplaceOptions options) throws ArangoDBException {
-        final DocumentReplaceOptions params = (options != null ? options : new DocumentReplaceOptions());
-        return executor
-                .execute(replaceDocumentsRequest(values, params), replaceDocumentsResponseDeserializer(values));
+        return replaceDocuments(values, options, (Class<T>) getCollectionContentClass(values));
+    }
+
+    @Override
+    public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values, DocumentReplaceOptions options, Class<T> type) throws ArangoDBException {
+        return executor.execute(replaceDocumentsRequest(values, options), replaceDocumentsResponseDeserializer(type));
     }
 
     @Override

src/main/java/com/arangodb/internal/InternalArangoCollection.java

@@ -241,9 +241,8 @@ protected <T> Request replaceDocumentsRequest(final Collection<T> values, final
     }
 
     protected <T> ResponseDeserializer<MultiDocumentEntity<DocumentUpdateEntity<T>>> replaceDocumentsResponseDeserializer(
-            final Collection<T> values) {
+            final Class<T> returnType) {
         return response -> {
-            Class<?> userDataClass = getCollectionContentClass(values);
             final MultiDocumentEntity<DocumentUpdateEntity<T>> multiDocument = new MultiDocumentEntity<>();
             final Collection<DocumentUpdateEntity<T>> docs = new ArrayList<>();
             final Collection<ErrorEntity> errors = new ArrayList<>();
@@ -256,7 +255,7 @@ protected <T> ResponseDeserializer<MultiDocumentEntity<DocumentUpdateEntity<T>>>
                     errors.add(error);
                     documentsAndErrors.add(error);
                 } else {
-                    Type type = constructParametricType(DocumentUpdateEntity.class, userDataClass);
+                    Type type = constructParametricType(DocumentUpdateEntity.class, returnType);
                     final DocumentUpdateEntity<T> doc = getSerde().deserialize(next, type);
                     docs.add(doc);
                     documentsAndErrors.add(doc);

src/main/java/com/arangodb/model/DocumentCreateOptions.java

@@ -86,11 +86,6 @@ public OverwriteMode getOverwriteMode() {
     }
 
     /**
-     * Limitations:
-     * - {@code keepNull} parameter is not supported
-     * - the fields having {@code null} value are always removed during serialization
-     * Therefore in case of {@link OverwriteMode#update}, existing attributes cannot be removed.
-     *
      * @param overwriteMode This parameter can be set to replace or update. If given it sets implicitly the overwrite
      *                      flag. In case it is set to update, the replace-insert becomes an update-insert. Otherwise
      *                      this option follows the rules of the overwrite parameter.

src/test/java/com/arangodb/ArangoCollectionTest.java

@@ -2573,7 +2573,7 @@ void replaceDocuments(ArangoCollection collection) {
             i.addAttribute("a", "test");
             updatedValues.add(i);
         }
-        final MultiDocumentEntity<DocumentUpdateEntity<BaseDocument>> updateResult = collection.replaceDocuments(updatedValues, null);
+        final MultiDocumentEntity<?> updateResult = collection.replaceDocuments(updatedValues);
         assertThat(updateResult.getDocuments()).hasSize(2);
         assertThat(updateResult.getErrors()).isEmpty();
     }
@@ -2636,7 +2636,7 @@ void replaceDocumentsJson(ArangoCollection collection) {
         final Collection<RawJson> updatedValues = new ArrayList<>();
         updatedValues.add(RawJson.of("{\"_key\":\"1\", \"foo\":\"bar\"}"));
         updatedValues.add(RawJson.of("{\"_key\":\"2\", \"foo\":\"bar\"}"));
-        final MultiDocumentEntity<DocumentUpdateEntity<RawJson>> updateResult = collection.replaceDocuments(updatedValues);
+        final MultiDocumentEntity<?> updateResult = collection.replaceDocuments(updatedValues);
         assertThat(updateResult.getDocuments()).hasSize(2);
         assertThat(updateResult.getErrors()).isEmpty();
     }

src/test/java/com/arangodb/async/ArangoCollectionTest.java

@@ -2157,7 +2157,7 @@ void replaceDocuments() throws InterruptedException, ExecutionException {
             i.addAttribute("a", "test");
             updatedValues.add(i);
         }
-        db.collection(COLLECTION_NAME).replaceDocuments(updatedValues, null)
+        db.collection(COLLECTION_NAME).replaceDocuments(updatedValues)
                 .whenComplete((updateResult, ex) -> {
                     assertThat(updateResult.getDocuments().size()).isEqualTo(2);
                     assertThat(updateResult.getErrors().size()).isEqualTo(0);