Skip to content

Commit 24281ec

Browse files
committed
chore: added javadoc improvements
Signed-off-by: Maximillian Arruda <dearrudam@gmail.com>
1 parent b6bec86 commit 24281ec

File tree

11 files changed

+66
-6
lines changed

11 files changed

+66
-6
lines changed

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBBucketManagerFactory.java

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,15 @@
2323
import java.util.Set;
2424

2525
/**
26-
* The ArangoDB implementation to {@link BucketManagerFactory}
27-
* it does not support:
26+
* The ArangoDB implementation to {@link BucketManagerFactory}.
27+
* It does not support:
2828
* <p>{@link BucketManagerFactory#getMap(String, Class, Class)}</p>
2929
* <p>{@link BucketManagerFactory#getSet(String, Class)}</p>
3030
* <p>{@link BucketManagerFactory#getQueue(String, Class)}</p>
3131
* <p>{@link BucketManagerFactory#getList(String, Class)}</p>
32+
* <br/>
33+
* Closing an ArangoDBBucketManagerFactory has no effect. The ArangoDB driver instance will be closed in
34+
* ${@link ArangoDBBucketManager}.close().
3235
*/
3336
public class ArangoDBBucketManagerFactory implements BucketManagerFactory {
3437

@@ -71,10 +74,13 @@ public List getList(String bucketName, Class clazz) throws UnsupportedOperationE
7174
throw new UnsupportedOperationException("The ArangoDB does not support getList method");
7275
}
7376

77+
/**
78+
* Closing an {@link ArangoDBBucketManagerFactory} has no effect.
79+
* The ArangoDB driver instance will be closed in ${@link ArangoDBBucketManager}.close().
80+
*/
7481
@Override
7582
public void close() {
7683
// no-op
77-
// ArangoDB driver instance will be closed in ArangoDBBucketManager.close()
7884
}
7985

8086
}

jnosql-cassandra/src/main/java/org/eclipse/jnosql/databases/cassandra/communication/CassandraColumnManagerFactory.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424

2525
/**
2626
* The Cassandra implementation to {@link DatabaseManagerFactory}
27+
* <br/>
28+
* Closing a {@link CassandraColumnManagerFactory} has no effect.
2729
*/
2830
public class CassandraColumnManagerFactory implements DatabaseManagerFactory {
2931

@@ -45,6 +47,9 @@ public CassandraColumnManager apply(String database) {
4547
return new DefaultCassandraColumnManager(sessionBuilder.build(), database);
4648
}
4749

50+
/**
51+
* Closing a {@link CassandraColumnManagerFactory} has no effect.
52+
*/
4853
@Override
4954
public void close() {
5055
}

jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/CouchbaseBucketManager.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@
3636

3737
/**
3838
* The couchbase implementation to {@link BucketManager}
39+
* <br/>
40+
* Closing a {@link CouchbaseBucketManager} has no effect.
3941
*/
4042
public class CouchbaseBucketManager implements BucketManager {
4143

@@ -148,6 +150,9 @@ public <K> void delete(Iterable<K> keys) {
148150
keys.forEach(this::delete);
149151
}
150152

153+
/**
154+
* Closing a {@link CouchbaseBucketManager} has no effect.
155+
*/
151156
@Override
152157
public void close() {
153158
}

jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/DefaultCouchbaseDocumentManager.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@
4343
import static java.util.Objects.requireNonNull;
4444

4545
/**
46-
* The default implementation of {@link CouchbaseDocumentManager}
46+
* The default implementation of {@link CouchbaseDocumentManager}.
47+
* <br/>
48+
* Closing a {@link DefaultCouchbaseDocumentManager} has no effect.
4749
*/
4850
class DefaultCouchbaseDocumentManager implements CouchbaseDocumentManager {
4951

@@ -225,6 +227,9 @@ public Stream<CommunicationEntity> n1qlQuery(String n1ql) throws NullPointerExce
225227
}
226228

227229

230+
/**
231+
* Closing a {@link DefaultCouchbaseDocumentManager} has no effect.
232+
*/
228233
@Override
229234
public void close() {
230235
}

jnosql-couchdb/src/main/java/org/eclipse/jnosql/databases/couchdb/communication/CouchDBDocumentManagerFactory.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@
2020

2121
import java.util.Objects;
2222

23+
/**
24+
* The couchdb implementation of {@link DatabaseManagerFactory} that returns {@link DefaultCouchDBDocumentManager}.
25+
* <br/>
26+
* Closing a {@link CouchDBDocumentManagerFactory} has no effect.
27+
*/
2328
public class CouchDBDocumentManagerFactory implements DatabaseManagerFactory {
2429

2530

@@ -39,6 +44,9 @@ public CouchDBDocumentManager apply(String database) {
3944
}
4045

4146

47+
/**
48+
* Closing a {@link CouchDBDocumentManagerFactory} has no effect.
49+
*/
4250
@Override
4351
public void close() {
4452
}

jnosql-hbase/src/main/java/org/eclipse/jnosql/databases/hbase/communication/HBaseColumnManagerFactory.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232
import java.util.List;
3333
import java.util.stream.Collectors;
3434

35+
/**
36+
* The HBase implementation of {@link DatabaseManagerFactory} that returns {@link HBaseColumnManager}.
37+
* <br/>
38+
* Closing an {@link HBaseColumnManagerFactory} has no effect.
39+
*/
3540
public class HBaseColumnManagerFactory implements DatabaseManagerFactory {
3641

3742
private final Configuration configuration;
@@ -85,6 +90,9 @@ private void createTable(Admin admin, TableName tableName) throws IOException {
8590
admin.createTable(descriptor);
8691
}
8792

93+
/**
94+
* Closing an {@link HBaseColumnManagerFactory} has no effect.
95+
*/
8896
@Override
8997
public void close() {
9098

jnosql-mongodb/src/main/java/org/eclipse/jnosql/databases/mongodb/communication/MongoDBDocumentManager.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
/**
5151
* The mongodb implementation to {@link DatabaseManager} that does not support TTL methods
5252
* <p>{@link MongoDBDocumentManager#insert(CommunicationEntity, Duration)}</p>
53+
* <p>Closing a {@link MongoDBDocumentManager} has no effect.
5354
*/
5455
public class MongoDBDocumentManager implements DatabaseManager {
5556

@@ -184,6 +185,9 @@ public long count(String documentCollection) {
184185
return collection.countDocuments();
185186
}
186187

188+
/**
189+
* Closing a {@link MongoDBDocumentManager} has no effect.
190+
*/
187191
@Override
188192
public void close() {
189193

jnosql-oracle-nosql/src/main/java/org/eclipse/jnosql/databases/oracle/communication/OracleDocumentManagerFactory.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323

2424
/**
2525
* The Oracle implementation to {@link DatabaseManagerFactory}
26+
* <br/>
27+
* Closing a {@link OracleDocumentManagerFactory} has no effect.
2628
*/
2729
public final class OracleDocumentManagerFactory implements DatabaseManagerFactory {
2830

@@ -33,6 +35,9 @@ public final class OracleDocumentManagerFactory implements DatabaseManagerFactor
3335
this.configuration = configuration;
3436
}
3537

38+
/**
39+
* Closing a {@link OracleDocumentManagerFactory} has no effect.
40+
*/
3641
@Override
3742
public void close() {
3843
}

jnosql-ravendb/src/main/java/org/eclipse/jnosql/databases/ravendb/communication/RavenDBDocumentManagerFactory.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323

2424
/**
2525
* The RavenDB implementation to {@link DatabaseManagerFactory}
26+
* <br/>
27+
* Closing a {@link RavenDBDocumentManagerFactory} has no effect.
2628
*/
2729
public class RavenDBDocumentManagerFactory implements DatabaseManagerFactory {
2830

@@ -39,7 +41,9 @@ public RavenDBDocumentManager apply(String database) {
3941
return new RavenDBDocumentManager(documentStore, database);
4042
}
4143

42-
44+
/**
45+
* Closing a {@link RavenDBDocumentManagerFactory} has no effect.
46+
*/
4347
@Override
4448
public void close() {
4549

jnosql-solr/src/main/java/org/eclipse/jnosql/databases/solr/communication/DefaultSolrDocumentManager.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@
4141
import static java.util.stream.Collectors.toList;
4242

4343
/**
44-
* The default implementation of {@link SolrDocumentManager}
44+
* The default implementation of {@link SolrDocumentManager}.
45+
* <br/>
46+
* Closing a {@link DefaultSolrDocumentManager} has no effect.
4547
*/
4648
class DefaultSolrDocumentManager implements SolrDocumentManager {
4749

@@ -182,6 +184,9 @@ public long count(String documentCollection) {
182184
}
183185
}
184186

187+
/**
188+
* Closing a {@link DefaultSolrDocumentManager} has no effect.
189+
*/
185190
@Override
186191
public void close() {
187192

0 commit comments

Comments
 (0)