javadoc upd

Author: rashtao

ChangeLog.md

@@ -8,11 +8,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [6.7.0_PREVIEW_3.7.1-alpha.1] - 2020-05-22
 
+- added support of `DisjointSmartGraphs` and `SatelliteGraphs` (ArangoDB v3.7)
+- added support of `storedValues` in `ArangoSearchProperties` (ArangoDB v3.7)
+- added support of `primarySortCompression` in `ArangoSearchProperties` (ArangoDB v3.7)
+- added support of `overwriteMode` on document creation, to allow `insert-ignore`, `insert-replace` and `insert-update` (ArangoDB v3.7)
 - added support of `mergeObjects` for insert document with `overwriteMode: update` (ArangoDB v3.7)
-- added support of `DisjointSmartGraphs` (ArangoDB v3.7)
-- added support of `ArangoSearchProperties` value `storedValues` (ArangoDB v3.7)
-- added support of `ArangoSearchProperties` value `primarySortCompression` (ArangoDB v3.7)
-- added support of `overwriteMode` values `ignore` and `conflict` (ArangoDB v3.7)
 - velocypack v2.3.1
 
 ## [6.6.3] - 2020-05-06

src/main/java/com/arangodb/entity/CollectionEntity.java

@@ -69,6 +69,10 @@ public CollectionType getType() {
         return type;
     }
 
+    /**
+     * @return Optional object that specifies the collection level schema for documents.
+     * @since ArangoDB 3.7
+     */
     public CollectionSchema getSchema() {
         return schema;
     }

src/main/java/com/arangodb/internal/velocypack/VPackSerializers.java

@@ -209,7 +209,6 @@ public class VPackSerializers {
             builder.close(); // close array
         }
 
-
     };
 
     private static void serializeFieldLinks(final VPackBuilder builder, final Collection<FieldLink> links) {

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

@@ -329,6 +329,11 @@ public CollectionSchema getSchema() {
         return schema;
     }
 
+    /**
+     * @param schema object that specifies the collection level schema for documents
+     * @since ArangoDB 3.7
+     * @return options
+     */
     public CollectionCreateOptions setSchema(final CollectionSchema schema) {
         this.schema = schema;
         return this;

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

@@ -24,12 +24,17 @@
 
 /**
  * @author Michele Rastelli
+ * @see <a href="https://www.arangodb.com/docs/stable/data-modeling-documents-schema-validation.html">API Documentation</a>
+ * @since ArangoDB 3.7
  */
 public class CollectionSchema {
     private String rule;
     private Level level;
     private String message;
 
+    /**
+     * @return JSON Schema description
+     */
     public String getRule() {
         return rule;
     }
@@ -39,6 +44,9 @@ public CollectionSchema setRule(String rule) {
         return this;
     }
 
+    /**
+     * @return controls when the validation will be applied
+     */
     public Level getLevel() {
         return level;
     }
@@ -48,6 +56,9 @@ public CollectionSchema setLevel(Level level) {
         return this;
     }
 
+    /**
+     * @return the message that will be used when validation fails
+     */
     public String getMessage() {
         return message;
     }
@@ -58,9 +69,28 @@ public CollectionSchema setMessage(String message) {
     }
 
     public enum Level {
+
+        /**
+         * The rule is inactive and validation thus turned off.
+         */
         NONE("none"),
+
+        /**
+         * Only newly inserted documents are validated.
+         */
         NEW("new"),
+
+        /**
+         * New and modified documents must pass validation, except for modified documents where the OLD value did not
+         * pass validation already. This level is useful if you have documents which do not match your target structure,
+         * but you want to stop the insertion of more invalid documents and prohibit that valid documents are changed to
+         * invalid documents.
+         */
         MODERATE("moderate"),
+
+        /**
+         * All new and modified document must strictly pass validation. No exceptions are made (default).
+         */
         STRICT("strict");
 
         private final String value;

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

@@ -109,6 +109,11 @@ public OverwriteMode getOverwriteMode() {
      *                      this option follows the rules of the overwrite parameter.
      * @return options
      * @since ArangoDB 3.7
+     *
+     * @implNote The current implementation has the following limitations:
+     * - `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.
      */
     public DocumentCreateOptions overwriteMode(final OverwriteMode overwriteMode) {
         this.overwriteMode = overwriteMode;
@@ -152,6 +157,8 @@ public Boolean getMergeObjects() {
      *                     document. If set to false, the value in the patch document will overwrite the existing document's
      *                     value. If set to true, objects will be merged. The default is true.
      * @return options
+     * @since ArangoDB 3.7
+     *
      * @apiNote only considered if {@link this#overwriteMode} is set to {@link OverwriteMode#update}
      */
     public DocumentCreateOptions mergeObjects(Boolean mergeObjects) {

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

@@ -98,6 +98,12 @@ public Boolean getIsDisjoint() {
         return getOptions().getIsDisjoint();
     }
 
+    /**
+     * @param isDisjoint If set to true, a Disjoint SmartGraph will be created. This flag is not editable after
+     *                   creation. Default: false.
+     * @return options
+     * @since ArangoDB 3.7
+     */
     public GraphCreateOptions isDisjoint(final Boolean isDisjoint) {
         getOptions().setIsDisjoint(isDisjoint);
         return this;

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

@@ -23,11 +23,36 @@
 
 /**
  * @author Michele Rastelli
+ * @since ArangoDB 3.7
  */
 public enum OverwriteMode {
+
+    /**
+     * if a document with the specified _key value exists already, nothing will be done and no write operation will be
+     * carried out. The insert operation will return success in this case. This mode does not support returning the old
+     * document version using RETURN OLD. When using RETURN NEW, null will be returned in case the document already
+     * existed.
+     */
     ignore("ignore"),
+
+    /**
+     * if a document with the specified _key value exists already, it will be overwritten with the specified document
+     * value. This mode will also be used when no overwrite mode is specified but the overwrite flag is set to true.
+     */
     replace("replace"),
+
+    /**
+     * if a document with the specified _key value exists already, it will be patched (partially updated) with the
+     * specified document value. The overwrite mode can be further controlled via the keepNull and mergeObjects
+     * parameters.
+     */
     update("update"),
+
+    /**
+     * if a document with the specified _key value exists already, return a unique constraint violation error so that
+     * the insert operation fails. This is also the default behavior in case the overwrite mode is not set, and the
+     * overwrite flag is false or not set either.
+     */
     conflict("conflict");
 
     private final String value;