Update JavaDocs

Author: clun

src/main/java/com/datastax/astra/client/Collection.java

@@ -188,7 +188,6 @@ public CollectionDefinition getDefinition() {
      * Retrieves the configuration options for the collection, including vector and indexing settings.
      * These options specify how the collection should be created and managed, potentially affecting
      * performance, search capabilities, and data organization.
-     * <p></p>
      * <p>Example usage:</p>
      * <pre>
      * {@code
@@ -268,12 +267,10 @@ public final InsertOneResult insertOne(DOC document) {
     /**
      * Insert a single document in the collection in an atomic operation.
      *
-     * <p>
      * <blockquote><b>Note:</b>If an `_id` is explicitly provided, which corresponds to a document
      * that exists already in the collection, an error is raised and the insertion fails.
      * Inserts the provided document. If the document is missing an identifier, the server will generate one.
      * </blockquote>
-     * </p>
      *
      * @param document
      *     the document expressing the document to insert. The `_id` field of the document can be left out, in which case it will be created automatically.
@@ -291,12 +288,10 @@ public final InsertOneResult insertOne(DOC document, float[] embeddings) {
     /**
      * Insert a single document in the collection in an atomic operation.
      *
-     * <p>
      * <blockquote><b>Note:</b>If an `_id` is explicitly provided, which corresponds to a document
      * that exists already in the collection, an error is raised and the insertion fails.
      * Inserts the provided document. If the document is missing an identifier, the server will generate one.
      * </blockquote>
-     * </p>
      *
      * @param document
      *     the document expressing the document to insert. The `_id` field of the document can be left out, in which case it will be created automatically.
@@ -341,7 +336,7 @@ private InsertOneResult _insertOne(Document document) {
      *      if the documents list is null or empty, or any of the documents in the list are null
      */
     public InsertManyResult insertMany(List<? extends DOC> documents) {
-        return insertMany(documents, InsertManyOptions.builder().build());
+        return insertMany(documents, new InsertManyOptions());
     }
 
     /**
@@ -447,6 +442,7 @@ public Optional<DOC> findOne(Filter filter) {
      *
      * @param filter The {@link Filter} instance containing the criteria used to identify the desired document.
      *               It specifies the conditions that a document must meet to be considered a match.
+     * @param options The {@link FindOneOptions} instance containing additional options for the find operation,
      * @return An {@link Optional<DOC>} that contains the found document if one exists that matches
      *         the filter criteria. Returns an empty {@link Optional} if no matching document is found,
      *         enabling safe retrieval operations without the risk of {@link java.util.NoSuchElementException}.
@@ -739,10 +735,29 @@ public int countDocuments(Filter filter, int upperBound) throws TooManyDocuments
     // ---   Delete            ----
     // ----------------------------
 
+    /**
+     * attribute for the delete count
+     */
     public static final String DELETED_COUNT = "deletedCount";
+
+    /**
+     * attribute for the matched count
+     */
     public static final String MATCHED_COUNT = "matchedCount";
+
+    /**
+     * attribute for the modified count
+     */
     public static final String MODIFIED_COUNT = "modifiedCount";
+
+    /**
+     * attribute for upserted Id
+     */
     public static final String UPSERTED_ID = "upsertedId";
+
+    /**
+     * attribute for the moreData
+     */
     public static final String MORE_DATA = "moreData";
 
     /**

src/main/java/com/datastax/astra/client/DataAPIOptions.java

@@ -144,6 +144,11 @@ public static class DataAPIClientOptionsBuilder {
         /** Default is to use Astra in Production. */
         private DataAPIDestination destination = DataAPIDestination.ASTRA;
 
+        /**
+         * Default constructor.
+         */
+        public DataAPIClientOptionsBuilder() {}
+
         /**
          * Builder pattern, update caller information.
          *
@@ -282,7 +287,7 @@ public DataAPIClientOptionsBuilder withDestination(DataAPIDestination destinatio
          * @param retryDelay the delay between two retry attempts, expressed in milliseconds.
          *                   Must be a non-negative number.
          * @return a reference to this builder, allowing for method chaining.
-         * <p></p>
+         *
          * Example usage:
          * <pre>
          * {@code

src/main/java/com/datastax/astra/client/Database.java

@@ -48,12 +48,7 @@
 @Slf4j
 public class Database extends AbstractCommandRunner {
 
-    /** Current Namespace information.
-     * -- GETTER --
-     *  Gets the name of the database.
-     *
-     * @return the database name
-     */
+    /** Current Namespace information.*/
     @Getter
     private final String namespaceName;
 
@@ -136,13 +131,20 @@ public Database(String apiEndpoint, String token, String namespace, DataAPIOptio
     // ----   Access Database Admin          ----
     // ------------------------------------------
 
+    /**
+     * Access a database Admin client from the database
+     * @return
+     *      database admin
+     */
     public DatabaseAdmin getDatabaseAdmin() {
         return getDatabaseAdmin(this.token);
     }
 
     /**
      * Gets the name of the database.
      *
+     * @param superUserToken
+     *      provide a token with super user role
      * @return the database name
      */
     public DatabaseAdmin getDatabaseAdmin(String superUserToken) {
@@ -245,6 +247,8 @@ public void drop() {
      *
      * @param collectionName
      *      the name for the new collection to create
+     * @return
+     *      the instance of collection
      */
     public Collection<Document> createCollection(String collectionName) {
         return createCollection(collectionName, null, Document.class);
@@ -275,6 +279,8 @@ public Collection<Document> createCollection(String collectionName, int dimensio
      *      vector metric
      * @param documentClass
      *      class of document to return
+     * @param <DOC>
+     *          working class for the document
      * @return
      *      the instance of collection
      */
@@ -290,6 +296,11 @@ public <DOC> Collection<DOC> createCollection(String collectionName, int dimensi
      *
      * @param collectionName
      *      the name for the new collection to create
+     * @param documentClass
+     *      class of document to return
+     * @param <DOC>
+     *          working class for the document
+     * @return the collection
      */
     public <DOC> Collection<DOC> createCollection(String collectionName, Class<DOC> documentClass) {
         return createCollection(collectionName, null, documentClass);
@@ -302,6 +313,7 @@ public <DOC> Collection<DOC> createCollection(String collectionName, Class<DOC>
      *      the name for the new collection to create
      * @param collectionOptions
      *      various options for creating the collection
+     * @return the collection
      */
     public Collection<Document> createCollection(String collectionName, CollectionOptions collectionOptions) {
         return createCollection(collectionName, collectionOptions, Document.class);
@@ -314,6 +326,11 @@ public Collection<Document> createCollection(String collectionName, CollectionOp
      *      the name for the new collection to create
      * @param collectionOptions
      *      various options for creating the collection
+     * @param documentClass
+     *     the default class to cast any documents returned from the database into.
+     * @param <DOC>
+     *          working class for the document
+     * @return the collection
      */
     public <DOC> Collection<DOC> createCollection(String collectionName, CollectionOptions collectionOptions, Class<DOC> documentClass) {
         hasLength(collectionName, "collectionName");

src/main/java/com/datastax/astra/client/exception/TooManyDocumentsToCountException.java

@@ -36,6 +36,9 @@ public TooManyDocumentsToCountException() {
 
     /**
      * Default constructor.
+     *
+     * @param upperLimit
+     *      what it the most the count can return
      */
     public TooManyDocumentsToCountException(int upperLimit) {
         super("Document count exceeds upper bound set in method call " + upperLimit);

src/main/java/com/datastax/astra/client/model/Command.java

@@ -53,7 +53,8 @@ public class Command implements Serializable {
      *
      * @param name
      *      unique command name
-     *
+     * @return
+     *      instance of the command
      */
     public static Command create(String name) {
         return new Command(name);
@@ -158,6 +159,8 @@ public Command withDocument(Object document) {
      *
      * @param documents
      *      documents for the command
+     * @param <DOC>
+     *      working clas for documents
      * @return
      *      self-reference
      */

src/main/java/com/datastax/astra/client/model/Document.java

@@ -243,6 +243,8 @@ public <T> T getId(@NonNull final Class<T> clazz) {
      *      id value
      * @param <T>
      *      type of id
+     * @return
+     *      self reference
      */
     public <T> Document id(T id) {
         return appendIfNotNull(ID, id);
@@ -285,6 +287,8 @@ public Optional<float[]>  getVector() {
      *
      * @param vector
      *      vector value
+     * @return
+     *      self reference
      */
     public Document vector(float[] vector) {
         return append(VECTOR, vector);
@@ -567,66 +571,79 @@ public String toJson() {
 
     // Vanilla Map methods delegate to map field
 
+    /** {@inheritDoc} */
     @Override
     public int size() {
         return documentMap.size();
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean isEmpty() {
         return documentMap.isEmpty();
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean containsValue(final Object value) {
         return documentMap.containsValue(value);
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean containsKey(final Object key) {
         return documentMap.containsKey(key);
     }
 
+    /** {@inheritDoc} */
     @Override
     public Object get(final Object key) {
         return documentMap.get(key);
     }
 
+    /** {@inheritDoc} */
     @Override
     public Object put(final String key, final Object value) {
         return documentMap.put(key, value);
     }
 
+    /** {@inheritDoc} */
     @Override
     public Object remove(final Object key) {
         return documentMap.remove(key);
     }
 
+    /** {@inheritDoc} */
     @Override
     public void putAll(final Map<? extends String, ?> map) {
         documentMap.putAll(map);
     }
 
+    /** {@inheritDoc} */
     @Override
     public void clear() {
         documentMap.clear();
     }
 
+    /** {@inheritDoc} */
     @Override
     public Set<String> keySet() {
         return documentMap.keySet();
     }
 
+    /** {@inheritDoc} */
     @Override
     public Collection<Object> values() {
         return documentMap.values();
     }
 
+    /** {@inheritDoc} */
     @Override
     public Set<Entry<String, Object>> entrySet() {
         return documentMap.entrySet();
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean equals(final Object o) {
         if (this == o) {
@@ -641,10 +658,10 @@ public boolean equals(final Object o) {
         if (!documentMap.equals(document.documentMap)) {
             return false;
         }
-
         return true;
     }
 
+    /** {@inheritDoc} */
     @Override
     public int hashCode() {
         return documentMap.hashCode();

src/main/java/com/datastax/astra/client/model/collections/CollectionDefinition.java

@@ -39,6 +39,11 @@ public class CollectionDefinition {
      */
     private CollectionOptions options;
 
+    /**
+     * Default constructor.
+     */
+    public CollectionDefinition() {}
+
     /** {@inheritDoc} */
     @Override
     public String toString() {

src/main/java/com/datastax/astra/client/model/collections/CollectionOptions.java

@@ -50,6 +50,11 @@ public class CollectionOptions {
      */
     private IndexingOptions indexing;
 
+    /**
+     * Default constructor.
+     */
+    public CollectionOptions() {}
+
     /**
      * Subclass representing the indexing options.
      */

src/main/java/com/datastax/astra/client/model/find/FindOneAndReplaceOptions.java

@@ -53,6 +53,11 @@ public class FindOneAndReplaceOptions {
      */
     ReturnDocument returnDocument = ReturnDocument.after;
 
+    /**
+     * Default constructor.
+     */
+    public FindOneAndReplaceOptions() {}
+
     /**
      * Options of the Return Document flag
      */

src/main/java/com/datastax/astra/client/model/find/FindOneAndReplaceResult.java

@@ -30,7 +30,6 @@
  *          working class document
  */
 @Data
-@NoArgsConstructor
 public class FindOneAndReplaceResult<DOC> {
 
     /**