Skip to content

Commit

Permalink
chore: added javadoc improvements
Browse files Browse the repository at this point in the history
Signed-off-by: Maximillian Arruda <[email protected]>
  • Loading branch information
dearrudam committed Dec 23, 2024
1 parent b6bec86 commit 24281ec
Show file tree
Hide file tree
Showing 11 changed files with 66 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down Expand Up @@ -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()
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@

/**
* The Cassandra implementation to {@link DatabaseManagerFactory}
* <br/>
* Closing a {@link CassandraColumnManagerFactory} has no effect.
*/
public class CassandraColumnManagerFactory implements DatabaseManagerFactory {

Expand All @@ -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() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@

/**
* The couchbase implementation to {@link BucketManager}
* <br/>
* Closing a {@link CouchbaseBucketManager} has no effect.
*/
public class CouchbaseBucketManager implements BucketManager {

Expand Down Expand Up @@ -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() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

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


/**
* Closing a {@link DefaultCouchbaseDocumentManager} has no effect.
*/
@Override
public void close() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {


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


/**
* Closing a {@link CouchDBDocumentManagerFactory} has no effect.
*/
@Override
public void close() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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() {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down Expand Up @@ -184,6 +185,9 @@ public long count(String documentCollection) {
return collection.countDocuments();
}

/**
* Closing a {@link MongoDBDocumentManager} has no effect.
*/
@Override
public void close() {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@

/**
* The Oracle implementation to {@link DatabaseManagerFactory}
* <br/>
* Closing a {@link OracleDocumentManagerFactory} has no effect.
*/
public final class OracleDocumentManagerFactory implements DatabaseManagerFactory {

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

/**
* Closing a {@link OracleDocumentManagerFactory} has no effect.
*/
@Override
public void close() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@

/**
* The RavenDB implementation to {@link DatabaseManagerFactory}
* <br/>
* Closing a {@link RavenDBDocumentManagerFactory} has no effect.
*/
public class RavenDBDocumentManagerFactory implements DatabaseManagerFactory {

Expand All @@ -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() {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down Expand Up @@ -182,6 +184,9 @@ public long count(String documentCollection) {
}
}

/**
* Closing a {@link DefaultSolrDocumentManager} has no effect.
*/
@Override
public void close() {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@

/**
* The solr implementation to {@link DatabaseManagerFactory}
* <br/>
* Closing a {@link SolrDocumentManagerFactory} has no effect.
*/
public class SolrDocumentManagerFactory implements DatabaseManagerFactory {

Expand All @@ -42,6 +44,9 @@ public SolrDocumentManager apply(String database) {
}


/**
* Closing a {@link SolrDocumentManagerFactory} has no effect.
*/
@Override
public void close() {
}
Expand Down

0 comments on commit 24281ec

Please sign in to comment.