From 24281ec1a31da8f4ee3256d58a455c6403b4f2cf Mon Sep 17 00:00:00 2001 From: Maximillian Arruda Date: Sun, 22 Dec 2024 22:01:24 -0300 Subject: [PATCH 1/2] chore: added javadoc improvements Signed-off-by: Maximillian Arruda --- .../communication/ArangoDBBucketManagerFactory.java | 12 +++++++++--- .../communication/CassandraColumnManagerFactory.java | 5 +++++ .../communication/CouchbaseBucketManager.java | 5 +++++ .../DefaultCouchbaseDocumentManager.java | 7 ++++++- .../communication/CouchDBDocumentManagerFactory.java | 8 ++++++++ .../communication/HBaseColumnManagerFactory.java | 8 ++++++++ .../communication/MongoDBDocumentManager.java | 4 ++++ .../communication/OracleDocumentManagerFactory.java | 5 +++++ .../communication/RavenDBDocumentManagerFactory.java | 6 +++++- .../communication/DefaultSolrDocumentManager.java | 7 ++++++- .../communication/SolrDocumentManagerFactory.java | 5 +++++ 11 files changed, 66 insertions(+), 6 deletions(-) diff --git a/jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBBucketManagerFactory.java b/jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBBucketManagerFactory.java index 1805ac498..cdb913f74 100644 --- a/jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBBucketManagerFactory.java +++ b/jnosql-arangodb/src/main/java/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: *

{@link BucketManagerFactory#getMap(String, Class, Class)}

*

{@link BucketManagerFactory#getSet(String, Class)}

*

{@link BucketManagerFactory#getQueue(String, Class)}

*

{@link BucketManagerFactory#getList(String, Class)}

+ *
+ * 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/src/main/java/org/eclipse/jnosql/databases/cassandra/communication/CassandraColumnManagerFactory.java b/jnosql-cassandra/src/main/java/org/eclipse/jnosql/databases/cassandra/communication/CassandraColumnManagerFactory.java index 15036ad72..2c52e7025 100644 --- a/jnosql-cassandra/src/main/java/org/eclipse/jnosql/databases/cassandra/communication/CassandraColumnManagerFactory.java +++ b/jnosql-cassandra/src/main/java/org/eclipse/jnosql/databases/cassandra/communication/CassandraColumnManagerFactory.java @@ -24,6 +24,8 @@ /** * The Cassandra implementation to {@link DatabaseManagerFactory} + *
+ * 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/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/CouchbaseBucketManager.java b/jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/CouchbaseBucketManager.java index 198eb6c83..957c7a04b 100644 --- a/jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/CouchbaseBucketManager.java +++ b/jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/CouchbaseBucketManager.java @@ -36,6 +36,8 @@ /** * The couchbase implementation to {@link BucketManager} + *
+ * Closing a {@link CouchbaseBucketManager} has no effect. */ public class CouchbaseBucketManager implements BucketManager { @@ -148,6 +150,9 @@ public void delete(Iterable keys) { keys.forEach(this::delete); } + /** + * Closing a {@link CouchbaseBucketManager} has no effect. + */ @Override public void close() { } diff --git a/jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/DefaultCouchbaseDocumentManager.java b/jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/DefaultCouchbaseDocumentManager.java index 70dcd5854..236b0fe4a 100644 --- a/jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/DefaultCouchbaseDocumentManager.java +++ b/jnosql-couchbase/src/main/java/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}. + *
+ * Closing a {@link DefaultCouchbaseDocumentManager} has no effect. */ class DefaultCouchbaseDocumentManager implements CouchbaseDocumentManager { @@ -225,6 +227,9 @@ public Stream n1qlQuery(String n1ql) throws NullPointerExce } + /** + * Closing a {@link DefaultCouchbaseDocumentManager} has no effect. + */ @Override public void close() { } diff --git a/jnosql-couchdb/src/main/java/org/eclipse/jnosql/databases/couchdb/communication/CouchDBDocumentManagerFactory.java b/jnosql-couchdb/src/main/java/org/eclipse/jnosql/databases/couchdb/communication/CouchDBDocumentManagerFactory.java index c25d0a424..191b2535e 100644 --- a/jnosql-couchdb/src/main/java/org/eclipse/jnosql/databases/couchdb/communication/CouchDBDocumentManagerFactory.java +++ b/jnosql-couchdb/src/main/java/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}. + *
+ * 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-hbase/src/main/java/org/eclipse/jnosql/databases/hbase/communication/HBaseColumnManagerFactory.java b/jnosql-hbase/src/main/java/org/eclipse/jnosql/databases/hbase/communication/HBaseColumnManagerFactory.java index aa5463b53..1b9cbae81 100644 --- a/jnosql-hbase/src/main/java/org/eclipse/jnosql/databases/hbase/communication/HBaseColumnManagerFactory.java +++ b/jnosql-hbase/src/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}. + *
+ * 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-mongodb/src/main/java/org/eclipse/jnosql/databases/mongodb/communication/MongoDBDocumentManager.java b/jnosql-mongodb/src/main/java/org/eclipse/jnosql/databases/mongodb/communication/MongoDBDocumentManager.java index 82f96caf0..519d2ad05 100644 --- a/jnosql-mongodb/src/main/java/org/eclipse/jnosql/databases/mongodb/communication/MongoDBDocumentManager.java +++ b/jnosql-mongodb/src/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 *

{@link MongoDBDocumentManager#insert(CommunicationEntity, Duration)}

+ *

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/src/main/java/org/eclipse/jnosql/databases/oracle/communication/OracleDocumentManagerFactory.java b/jnosql-oracle-nosql/src/main/java/org/eclipse/jnosql/databases/oracle/communication/OracleDocumentManagerFactory.java index 82270d1d7..905f5096b 100644 --- a/jnosql-oracle-nosql/src/main/java/org/eclipse/jnosql/databases/oracle/communication/OracleDocumentManagerFactory.java +++ b/jnosql-oracle-nosql/src/main/java/org/eclipse/jnosql/databases/oracle/communication/OracleDocumentManagerFactory.java @@ -23,6 +23,8 @@ /** * The Oracle implementation to {@link DatabaseManagerFactory} + *
+ * 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-ravendb/src/main/java/org/eclipse/jnosql/databases/ravendb/communication/RavenDBDocumentManagerFactory.java b/jnosql-ravendb/src/main/java/org/eclipse/jnosql/databases/ravendb/communication/RavenDBDocumentManagerFactory.java index 03edfc80c..cff9a6fab 100644 --- a/jnosql-ravendb/src/main/java/org/eclipse/jnosql/databases/ravendb/communication/RavenDBDocumentManagerFactory.java +++ b/jnosql-ravendb/src/main/java/org/eclipse/jnosql/databases/ravendb/communication/RavenDBDocumentManagerFactory.java @@ -23,6 +23,8 @@ /** * The RavenDB implementation to {@link DatabaseManagerFactory} + *
+ * 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-solr/src/main/java/org/eclipse/jnosql/databases/solr/communication/DefaultSolrDocumentManager.java b/jnosql-solr/src/main/java/org/eclipse/jnosql/databases/solr/communication/DefaultSolrDocumentManager.java index 2bd17b06d..656d3f7b4 100644 --- a/jnosql-solr/src/main/java/org/eclipse/jnosql/databases/solr/communication/DefaultSolrDocumentManager.java +++ b/jnosql-solr/src/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}. + *
+ * 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/jnosql-solr/src/main/java/org/eclipse/jnosql/databases/solr/communication/SolrDocumentManagerFactory.java b/jnosql-solr/src/main/java/org/eclipse/jnosql/databases/solr/communication/SolrDocumentManagerFactory.java index 6ce063a83..f9ca21fcc 100644 --- a/jnosql-solr/src/main/java/org/eclipse/jnosql/databases/solr/communication/SolrDocumentManagerFactory.java +++ b/jnosql-solr/src/main/java/org/eclipse/jnosql/databases/solr/communication/SolrDocumentManagerFactory.java @@ -22,6 +22,8 @@ /** * The solr implementation to {@link DatabaseManagerFactory} + *
+ * 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() { } From f38fa0b19557355f92591bdf16502694d5e0c4d0 Mon Sep 17 00:00:00 2001 From: Maximillian Arruda Date: Sun, 22 Dec 2024 22:41:09 -0300 Subject: [PATCH 2/2] chore: update snapshot Signed-off-by: Maximillian Arruda --- jnosql-arangodb/pom.xml | 2 +- jnosql-cassandra/pom.xml | 2 +- jnosql-couchbase/pom.xml | 2 +- jnosql-couchdb/pom.xml | 2 +- jnosql-database-commons/pom.xml | 2 +- jnosql-dynamodb/pom.xml | 2 +- jnosql-elasticsearch/pom.xml | 2 +- jnosql-hazelcast/pom.xml | 2 +- jnosql-hbase/pom.xml | 2 +- jnosql-infinispan/pom.xml | 2 +- jnosql-memcached/pom.xml | 2 +- jnosql-mongodb/pom.xml | 2 +- jnosql-oracle-nosql/pom.xml | 2 +- jnosql-orientdb/pom.xml | 2 +- jnosql-ravendb/pom.xml | 2 +- jnosql-redis/pom.xml | 2 +- jnosql-riak/pom.xml | 2 +- jnosql-solr/pom.xml | 2 +- jnosql-tinkerpop/pom.xml | 2 +- pom.xml | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-) diff --git a/jnosql-arangodb/pom.xml b/jnosql-arangodb/pom.xml index 9d8e6c0c0..264176a34 100644 --- a/jnosql-arangodb/pom.xml +++ b/jnosql-arangodb/pom.xml @@ -21,7 +21,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-arangodb diff --git a/jnosql-cassandra/pom.xml b/jnosql-cassandra/pom.xml index 955ac3730..a29e97c35 100644 --- a/jnosql-cassandra/pom.xml +++ b/jnosql-cassandra/pom.xml @@ -21,7 +21,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-cassandra diff --git a/jnosql-couchbase/pom.xml b/jnosql-couchbase/pom.xml index 06e8b1cb7..02fcbea01 100644 --- a/jnosql-couchbase/pom.xml +++ b/jnosql-couchbase/pom.xml @@ -21,7 +21,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-couchbase diff --git a/jnosql-couchdb/pom.xml b/jnosql-couchdb/pom.xml index dbeab9fca..a86db4028 100644 --- a/jnosql-couchdb/pom.xml +++ b/jnosql-couchdb/pom.xml @@ -21,7 +21,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-couchdb diff --git a/jnosql-database-commons/pom.xml b/jnosql-database-commons/pom.xml index f3562a203..d7c0cce66 100644 --- a/jnosql-database-commons/pom.xml +++ b/jnosql-database-commons/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-database-commons diff --git a/jnosql-dynamodb/pom.xml b/jnosql-dynamodb/pom.xml index df993c5e7..c9dc75f52 100644 --- a/jnosql-dynamodb/pom.xml +++ b/jnosql-dynamodb/pom.xml @@ -15,7 +15,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-dynamodb diff --git a/jnosql-elasticsearch/pom.xml b/jnosql-elasticsearch/pom.xml index b3d9a4302..301ca39bd 100644 --- a/jnosql-elasticsearch/pom.xml +++ b/jnosql-elasticsearch/pom.xml @@ -21,7 +21,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-elasticsearch diff --git a/jnosql-hazelcast/pom.xml b/jnosql-hazelcast/pom.xml index 4da403fce..2e2fc9f3a 100644 --- a/jnosql-hazelcast/pom.xml +++ b/jnosql-hazelcast/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-hazelcast diff --git a/jnosql-hbase/pom.xml b/jnosql-hbase/pom.xml index 75a9ff1ca..c1737f302 100644 --- a/jnosql-hbase/pom.xml +++ b/jnosql-hbase/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-hbase diff --git a/jnosql-infinispan/pom.xml b/jnosql-infinispan/pom.xml index 4cec32f8c..c4d47f311 100644 --- a/jnosql-infinispan/pom.xml +++ b/jnosql-infinispan/pom.xml @@ -19,7 +19,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-infinispan diff --git a/jnosql-memcached/pom.xml b/jnosql-memcached/pom.xml index f35b65e6b..5212a01cc 100644 --- a/jnosql-memcached/pom.xml +++ b/jnosql-memcached/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-memcached diff --git a/jnosql-mongodb/pom.xml b/jnosql-mongodb/pom.xml index 51b3f971b..45dc44fc3 100644 --- a/jnosql-mongodb/pom.xml +++ b/jnosql-mongodb/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-mongodb diff --git a/jnosql-oracle-nosql/pom.xml b/jnosql-oracle-nosql/pom.xml index 14909c421..df3ebd09e 100644 --- a/jnosql-oracle-nosql/pom.xml +++ b/jnosql-oracle-nosql/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-oracle-nosql diff --git a/jnosql-orientdb/pom.xml b/jnosql-orientdb/pom.xml index 4b40788cb..cd5c1981c 100644 --- a/jnosql-orientdb/pom.xml +++ b/jnosql-orientdb/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-orientdb diff --git a/jnosql-ravendb/pom.xml b/jnosql-ravendb/pom.xml index fe65d0407..98dd6ba07 100644 --- a/jnosql-ravendb/pom.xml +++ b/jnosql-ravendb/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-ravendb diff --git a/jnosql-redis/pom.xml b/jnosql-redis/pom.xml index a40148eb7..8e5dac2b1 100644 --- a/jnosql-redis/pom.xml +++ b/jnosql-redis/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-redis diff --git a/jnosql-riak/pom.xml b/jnosql-riak/pom.xml index 96d9d4621..7bd00a361 100644 --- a/jnosql-riak/pom.xml +++ b/jnosql-riak/pom.xml @@ -21,7 +21,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-riak diff --git a/jnosql-solr/pom.xml b/jnosql-solr/pom.xml index 616ea0f4c..6995f56ec 100644 --- a/jnosql-solr/pom.xml +++ b/jnosql-solr/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-solr diff --git a/jnosql-tinkerpop/pom.xml b/jnosql-tinkerpop/pom.xml index 9c11d2458..ea2855b4f 100644 --- a/jnosql-tinkerpop/pom.xml +++ b/jnosql-tinkerpop/pom.xml @@ -20,7 +20,7 @@ org.eclipse.jnosql.databases jnosql-databases-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT jnosql-tinkerpop diff --git a/pom.xml b/pom.xml index f342fc72f..9c3340ab3 100644 --- a/pom.xml +++ b/pom.xml @@ -22,7 +22,7 @@ org.eclipse.jnosql.mapping jnosql-mapping-parent - 1.1.5--SNAPSHOT + 1.1.5-SNAPSHOT org.eclipse.jnosql.databases