documented limitations about operations with fields having null values

Author: rashtao

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

@@ -60,9 +60,6 @@ public interface ArangoCollection extends ArangoSerializationAccessor {
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
      * Documentation</a>
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     <T> DocumentCreateEntity<T> insertDocument(T value) throws ArangoDBException;
 
@@ -76,9 +73,6 @@ public interface ArangoCollection extends ArangoSerializationAccessor {
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
      * Documentation</a>
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     <T> DocumentCreateEntity<T> insertDocument(T value, DocumentCreateOptions options) throws ArangoDBException;
 
@@ -120,6 +114,9 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
      * @param values a list of Objects that will be stored as documents
      * @return information about the import
      * @throws ArangoDBException
+     *
+     * @implNote The current implementation has the following limitations:
+     * - the fields having {@code null} value are always removed during serialization
      */
     DocumentImportEntity importDocuments(Collection<?> values) throws ArangoDBException;
 
@@ -130,6 +127,9 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
      * @param options Additional options, can be null
      * @return information about the import
      * @throws ArangoDBException
+     *
+     * @implNote The current implementation has the following limitations:
+     * - the fields having {@code null} value are always removed during serialization
      */
     DocumentImportEntity importDocuments(Collection<?> values, DocumentImportOptions options) throws ArangoDBException;
 
@@ -139,6 +139,9 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
      * @param values JSON-encoded array of objects that will be stored as documents
      * @return information about the import
      * @throws ArangoDBException
+     *
+     * @implNote The current implementation has the following limitations:
+     * - the fields having {@code null} value are always removed during serialization
      */
     DocumentImportEntity importDocuments(String values) throws ArangoDBException;
 
@@ -149,6 +152,9 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
      * @param options Additional options, can be null
      * @return information about the import
      * @throws ArangoDBException
+     *
+     * @implNote The current implementation has the following limitations:
+     * - the fields having {@code null} value are always removed during serialization
      */
     DocumentImportEntity importDocuments(String values, DocumentImportOptions options) throws ArangoDBException;
 
@@ -236,6 +242,9 @@ <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplace
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
      * Documentation</a>
+     *
+     * @implNote The current implementation has the following limitations:
+     * - the fields having {@code null} value are always removed during serialization
      */
     <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values) throws ArangoDBException;
 
@@ -249,6 +258,9 @@ <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplace
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
      * Documentation</a>
+     *
+     * @implNote The current implementation has the following limitations:
+     * - the fields having {@code null} value are always removed during serialization
      */
     <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(
             Collection<T> values, DocumentReplaceOptions options) throws ArangoDBException;