Merge pull request #305 from eclipse-jnosql/javadoc-improvements

chore: added javadoc improvements
eclipse-jnosql · Dec 23, 2024 · 949208d · 949208d
2 parents b6bec86 + f38fa0b
commit 949208d
Show file tree

Hide file tree

Showing 31 changed files with 86 additions and 26 deletions.
diff --git a/jnosql-arangodb/pom.xml b/jnosql-arangodb/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-arangodb</artifactId>

diff --git a/...ava/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBBucketManagerFactory.java b/...ava/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBBucketManagerFactory.java
@@ -23,12 +23,15 @@
 import java.util.Set;
 
 /**
- * The ArangoDB implementation to {@link BucketManagerFactory}
- * it does not support:
+ * The ArangoDB implementation to {@link BucketManagerFactory}.
+ * It does not support:
  * <p>{@link BucketManagerFactory#getMap(String, Class, Class)}</p>
  * <p>{@link BucketManagerFactory#getSet(String, Class)}</p>
  * <p>{@link BucketManagerFactory#getQueue(String, Class)}</p>
  * <p>{@link BucketManagerFactory#getList(String, Class)}</p>
+ * <br/>
+ * Closing an ArangoDBBucketManagerFactory has no effect. The ArangoDB driver instance will be closed in
+ * ${@link ArangoDBBucketManager}.close().
  */
 public class ArangoDBBucketManagerFactory implements BucketManagerFactory {
 
@@ -71,10 +74,13 @@ public List getList(String bucketName, Class clazz) throws UnsupportedOperationE
         throw new UnsupportedOperationException("The ArangoDB does not support getList method");
     }
 
+    /**
+     * Closing an {@link ArangoDBBucketManagerFactory} has no effect.
+     * The ArangoDB driver instance will be closed in ${@link ArangoDBBucketManager}.close().
+     */
     @Override
     public void close() {
         // no-op
-        // ArangoDB driver instance will be closed in ArangoDBBucketManager.close()
     }
 
 }
diff --git a/jnosql-cassandra/pom.xml b/jnosql-cassandra/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-cassandra</artifactId>

diff --git a/...a/org/eclipse/jnosql/databases/cassandra/communication/CassandraColumnManagerFactory.java b/...a/org/eclipse/jnosql/databases/cassandra/communication/CassandraColumnManagerFactory.java
@@ -24,6 +24,8 @@
 
 /**
  * The Cassandra implementation to {@link DatabaseManagerFactory}
+ * <br/>
+ * Closing a {@link CassandraColumnManagerFactory} has no effect.
  */
 public class CassandraColumnManagerFactory implements DatabaseManagerFactory {
 
@@ -45,6 +47,9 @@ public CassandraColumnManager apply(String database) {
         return new DefaultCassandraColumnManager(sessionBuilder.build(), database);
     }
 
+    /**
+     * Closing a {@link CassandraColumnManagerFactory} has no effect.
+     */
     @Override
     public void close() {
     }

diff --git a/jnosql-couchbase/pom.xml b/jnosql-couchbase/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-couchbase</artifactId>

diff --git a/...ain/java/org/eclipse/jnosql/databases/couchbase/communication/CouchbaseBucketManager.java b/...ain/java/org/eclipse/jnosql/databases/couchbase/communication/CouchbaseBucketManager.java
@@ -36,6 +36,8 @@
 
 /**
  * The couchbase implementation to {@link BucketManager}
+ * <br/>
+ * Closing a {@link CouchbaseBucketManager} has no effect.
  */
 public class CouchbaseBucketManager implements BucketManager {
 
@@ -148,6 +150,9 @@ public <K> void delete(Iterable<K> keys) {
         keys.forEach(this::delete);
     }
 
+    /**
+     * Closing a {@link CouchbaseBucketManager} has no effect.
+     */
     @Override
     public void close() {
     }

diff --git a/...org/eclipse/jnosql/databases/couchbase/communication/DefaultCouchbaseDocumentManager.java b/...org/eclipse/jnosql/databases/couchbase/communication/DefaultCouchbaseDocumentManager.java
@@ -43,7 +43,9 @@
 import static java.util.Objects.requireNonNull;
 
 /**
- * The default implementation of {@link CouchbaseDocumentManager}
+ * The default implementation of {@link CouchbaseDocumentManager}.
+ * <br/>
+ * Closing a {@link DefaultCouchbaseDocumentManager} has no effect.
  */
 class DefaultCouchbaseDocumentManager implements CouchbaseDocumentManager {
 
@@ -225,6 +227,9 @@ public Stream<CommunicationEntity> n1qlQuery(String n1ql) throws NullPointerExce
     }
 
 
+    /**
+     * Closing a {@link DefaultCouchbaseDocumentManager} has no effect.
+     */
     @Override
     public void close() {
     }

diff --git a/jnosql-couchdb/pom.xml b/jnosql-couchdb/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-couchdb</artifactId>

diff --git a/...ava/org/eclipse/jnosql/databases/couchdb/communication/CouchDBDocumentManagerFactory.java b/...ava/org/eclipse/jnosql/databases/couchdb/communication/CouchDBDocumentManagerFactory.java
@@ -20,6 +20,11 @@
 
 import java.util.Objects;
 
+/**
+ * The couchdb implementation of {@link DatabaseManagerFactory} that returns {@link DefaultCouchDBDocumentManager}.
+ * <br/>
+ * Closing a {@link CouchDBDocumentManagerFactory} has no effect.
+ */
 public class CouchDBDocumentManagerFactory implements DatabaseManagerFactory {
 
 
@@ -39,6 +44,9 @@ public CouchDBDocumentManager apply(String database) {
     }
 
 
+    /**
+     * Closing a {@link CouchDBDocumentManagerFactory} has no effect.
+     */
     @Override
     public void close() {
     }

diff --git a/jnosql-database-commons/pom.xml b/jnosql-database-commons/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-database-commons</artifactId>

diff --git a/jnosql-dynamodb/pom.xml b/jnosql-dynamodb/pom.xml
@@ -15,7 +15,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-dynamodb</artifactId>

diff --git a/jnosql-elasticsearch/pom.xml b/jnosql-elasticsearch/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-elasticsearch</artifactId>

diff --git a/jnosql-hazelcast/pom.xml b/jnosql-hazelcast/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-hazelcast</artifactId>

diff --git a/jnosql-hbase/pom.xml b/jnosql-hbase/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-hbase</artifactId>

diff --git a/...main/java/org/eclipse/jnosql/databases/hbase/communication/HBaseColumnManagerFactory.java b/...main/java/org/eclipse/jnosql/databases/hbase/communication/HBaseColumnManagerFactory.java
@@ -32,6 +32,11 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+/**
+ * The HBase implementation of {@link DatabaseManagerFactory} that returns {@link HBaseColumnManager}.
+ * <br/>
+ * Closing an {@link HBaseColumnManagerFactory} has no effect.
+ */
 public class HBaseColumnManagerFactory implements DatabaseManagerFactory {
 
     private final Configuration configuration;
@@ -85,6 +90,9 @@ private void createTable(Admin admin, TableName tableName) throws IOException {
         admin.createTable(descriptor);
     }
 
+    /**
+     * Closing an {@link HBaseColumnManagerFactory} has no effect.
+     */
     @Override
     public void close() {
 

diff --git a/jnosql-infinispan/pom.xml b/jnosql-infinispan/pom.xml
@@ -19,7 +19,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-infinispan</artifactId>

diff --git a/jnosql-memcached/pom.xml b/jnosql-memcached/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-memcached</artifactId>

diff --git a/jnosql-mongodb/pom.xml b/jnosql-mongodb/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-mongodb</artifactId>

diff --git a/.../main/java/org/eclipse/jnosql/databases/mongodb/communication/MongoDBDocumentManager.java b/.../main/java/org/eclipse/jnosql/databases/mongodb/communication/MongoDBDocumentManager.java
@@ -50,6 +50,7 @@
 /**
  * The mongodb implementation to {@link DatabaseManager} that does not support TTL methods
  * <p>{@link MongoDBDocumentManager#insert(CommunicationEntity, Duration)}</p>
+ * <p>Closing a {@link MongoDBDocumentManager} has no effect.
  */
 public class MongoDBDocumentManager implements DatabaseManager {
 
@@ -184,6 +185,9 @@ public long count(String documentCollection) {
         return collection.countDocuments();
     }
 
+    /**
+     * Closing a {@link MongoDBDocumentManager} has no effect.
+     */
     @Override
     public void close() {
 

diff --git a/jnosql-oracle-nosql/pom.xml b/jnosql-oracle-nosql/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-oracle-nosql</artifactId>

diff --git a/.../java/org/eclipse/jnosql/databases/oracle/communication/OracleDocumentManagerFactory.java b/.../java/org/eclipse/jnosql/databases/oracle/communication/OracleDocumentManagerFactory.java
@@ -23,6 +23,8 @@
 
 /**
  * The Oracle implementation to {@link DatabaseManagerFactory}
+ * <br/>
+ * Closing a {@link OracleDocumentManagerFactory} has no effect.
  */
 public final class OracleDocumentManagerFactory implements DatabaseManagerFactory {
 
@@ -33,6 +35,9 @@ public final class OracleDocumentManagerFactory implements DatabaseManagerFactor
         this.configuration = configuration;
     }
 
+    /**
+     * Closing a {@link OracleDocumentManagerFactory} has no effect.
+     */
     @Override
     public void close() {
     }

diff --git a/jnosql-orientdb/pom.xml b/jnosql-orientdb/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-orientdb</artifactId>

diff --git a/jnosql-ravendb/pom.xml b/jnosql-ravendb/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-ravendb</artifactId>

diff --git a/...ava/org/eclipse/jnosql/databases/ravendb/communication/RavenDBDocumentManagerFactory.java b/...ava/org/eclipse/jnosql/databases/ravendb/communication/RavenDBDocumentManagerFactory.java
@@ -23,6 +23,8 @@
 
 /**
  * The RavenDB implementation to {@link DatabaseManagerFactory}
+ * <br/>
+ * Closing a {@link RavenDBDocumentManagerFactory} has no effect.
  */
 public class RavenDBDocumentManagerFactory implements DatabaseManagerFactory {
 
@@ -39,7 +41,9 @@ public RavenDBDocumentManager apply(String database) {
         return new RavenDBDocumentManager(documentStore, database);
     }
 
-
+    /**
+     * Closing a {@link RavenDBDocumentManagerFactory} has no effect.
+     */
     @Override
     public void close() {
 

diff --git a/jnosql-redis/pom.xml b/jnosql-redis/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-redis</artifactId>

diff --git a/jnosql-riak/pom.xml b/jnosql-riak/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-riak</artifactId>

diff --git a/jnosql-solr/pom.xml b/jnosql-solr/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <groupId>org.eclipse.jnosql.databases</groupId>
         <artifactId>jnosql-databases-parent</artifactId>
-        <version>1.1.5--SNAPSHOT</version>
+        <version>1.1.5-SNAPSHOT</version>
     </parent>
 
     <artifactId>jnosql-solr</artifactId>

diff --git a/...main/java/org/eclipse/jnosql/databases/solr/communication/DefaultSolrDocumentManager.java b/...main/java/org/eclipse/jnosql/databases/solr/communication/DefaultSolrDocumentManager.java
@@ -41,7 +41,9 @@
 import static java.util.stream.Collectors.toList;
 
 /**
- * The default implementation of {@link SolrDocumentManager}
+ * The default implementation of {@link SolrDocumentManager}.
+ * <br/>
+ * Closing a {@link DefaultSolrDocumentManager} has no effect.
  */
 class DefaultSolrDocumentManager implements SolrDocumentManager {
 
@@ -182,6 +184,9 @@ public long count(String documentCollection) {
         }
     }
 
+    /**
+     * Closing a {@link DefaultSolrDocumentManager} has no effect.
+     */
     @Override
     public void close() {
 

diff --git a/...main/java/org/eclipse/jnosql/databases/solr/communication/SolrDocumentManagerFactory.java b/...main/java/org/eclipse/jnosql/databases/solr/communication/SolrDocumentManagerFactory.java
@@ -22,6 +22,8 @@
 
 /**
  * The solr implementation to {@link DatabaseManagerFactory}
+ * <br/>
+ * Closing a {@link SolrDocumentManagerFactory} has no effect.
  */
 public class SolrDocumentManagerFactory implements DatabaseManagerFactory {
 
@@ -42,6 +44,9 @@ public SolrDocumentManager apply(String database) {
     }
 
 
+    /**
+     * Closing a {@link SolrDocumentManagerFactory} has no effect.
+     */
     @Override
     public void close() {
     }