Merge pull request #198 from eclipse/update-documentation

Update documentation

Author: otaviojava

README.adoc

@@ -38,7 +38,7 @@ Please note that you can establish properties using the https://microprofile.io/
 |Configuration property |Description
 
 |`jnosql.jnosql.arangodb.host`
-|The database host, where you need to put the port split by colons. E.g., localhost:8529
+|The database host, where you need to put the port split by colons. E.g.: jnosql.jnosql.arangodb.host=localhost:8529
 
 |`jnosql.arangodb.user`
 |The user's userID.
@@ -119,7 +119,7 @@ Please note that you can establish properties using the https://microprofile.io/
 |The user's password
 
 |`jnosql.cassandra.host`
-|Database's host. It is a prefix to enumerate hosts. E.g.: cassandra.host.1=localhost
+|Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.cassandra.host.1=localhost
 
 |`jnosql.cassandra.name`
 |The name of the application using the created session.
@@ -128,7 +128,7 @@ Please note that you can establish properties using the https://microprofile.io/
 |The cassandra's port
 
 |`jnosql.cassandra.query`
-|The Cassandra CQL to execute when the configuration starts. It uses as a prefix. E.g.: cassandra.query.1=<CQL>
+|The Cassandra CQL to execute when the configuration starts. It uses as a prefix. E.g.: jnosql.cassandra.query.1=<CQL>
 
 |`jnosql.cassandra.data.center`
 |The datacenter that is considered "local" by the load balancing policy.
@@ -331,7 +331,7 @@ Please note that you can establish properties using the https://microprofile.io/
 |Configuration property |Description
 
 |`jnosql.elasticsearch.host`
-|Database's host. It is a prefix to enumerate hosts. E.g.: elasticsearch.host.1=172.17.0.2:1234
+|Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.elasticsearch.host.1=172.17.0.2:1234
 
 |`jnosql.elasticsearch.user`
 |The user's userID.
@@ -383,7 +383,7 @@ Please note that you can establish properties using the https://microprofile.io/
 |The instance name uniquely identifying the hazelcast instance created by this configuration. This name is used in different scenarios, such as identifying the hazelcast instance when running multiple instances in the same JVM.
 
 |`jnosql.hazelcast.host`
-|Database's host. It is a prefix to enumerate hosts. E.g.: hazelcast.host.1=localhost
+|Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.hazelcast.host.1=localhost
 
 |`jnosql.hazelcast.port`
 |The database port
@@ -441,7 +441,7 @@ Please note that you can establish properties using the https://microprofile.io/
 |Configuration property |Description
 
 |`jnosql.hbase.family`
-|The Column family prefixes. E.g.: hbase.family.1=<FAMILY>
+|The Column family prefixes. E.g.: jnosql.hbase.family.1=<FAMILY>
 
 |===
 
@@ -484,10 +484,10 @@ Please note that you can establish properties using the https://microprofile.io/
 |Configuration property |Description
 
 |`jnosql.infinispan.host`
-|Database's host. It is a prefix to enumerate hosts. E.g.: infinispan.host.1=HOST
+|Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.infinispan.host.1=HOST
 
 |`jnosql.infinispan.config`
-|The Infinispan configuration path. E.g.: infinispan.config=infinispan.xml
+|The Infinispan configuration path. E.g.: jnosql.infinispan.config=infinispan.xml
 
 |===
 
@@ -573,7 +573,7 @@ Please note that you can establish properties using the https://microprofile.io/
 |The user's password.
 
 |`jnosql.memcached.host`
-|Database's host. It is a prefix to enumerate hosts. E.g.: memcached.host.1=localhost:11211
+|Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.memcached.host.1=localhost:11211
 
 |===
 
@@ -898,7 +898,7 @@ Please note that you can establish properties using the https://microprofile.io/
 |Configuration property |Description
 
 |`jnosql.solr.host`
-|Database's host. It is a prefix to enumerate hosts. E.g.: solr.host.1=HOST
+|Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.solr.host.1=HOST
 
 |`jnosql.solr.user`
 |The user's userID.

jnosql-arangodb-driver/src/main/java/org/eclipse/jnosql/communication/arangodb/ArangoDBConfigurations.java

@@ -28,7 +28,7 @@ public enum ArangoDBConfigurations implements Supplier<String> {
 
 
     /**
-     * The database host, where you need to put the port split by colons. E.g., localhost:8529
+     * The database host, where you need to put the port split by colons. E.g.: jnosql.arangodb.host=localhost:8529
      */
     HOST("jnosql.arangodb.host"),
     /**

jnosql-arangodb-driver/src/main/java/org/eclipse/jnosql/communication/arangodb/document/ArangoDBDocumentManagerFactory.java

@@ -18,7 +18,7 @@
 import com.arangodb.ArangoDB;
 import jakarta.nosql.document.DocumentManagerFactory;
 
-final class ArangoDBDocumentManagerFactory implements DocumentManagerFactory {
+public final class ArangoDBDocumentManagerFactory implements DocumentManagerFactory {
 
 
     private final ArangoDB arangoDB;

jnosql-cassandra-driver/src/main/java/org/eclipse/jnosql/communication/cassandra/column/CassandraConfigurations.java

@@ -35,7 +35,7 @@ public enum CassandraConfigurations implements Supplier<String> {
      */
     PASSWORD("jnosql.cassandra.password"),
     /**
-     * Database's host. It is a prefix to enumerate hosts. E.g.: cassandra.host.1=localhost
+     * Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.cassandra.host.1=localhost
      */
     HOST("jnosql.cassandra.host"),
     /**
@@ -47,7 +47,7 @@ public enum CassandraConfigurations implements Supplier<String> {
      */
     PORT("jnosql.cassandra.port"),
     /**
-     * The Cassandra CQL to execute when the configuration starts. It uses as a prefix. E.g.: cassandra.query.1=CQL
+     * The Cassandra CQL to execute when the configuration starts. It uses as a prefix. E.g.: jnosql.cassandra.query.1=CQL
      */
     QUERY("jnosql.cassandra.query"),
     /**

jnosql-elasticsearch-driver/src/main/java/org/eclipse/jnosql/communication/elasticsearch/document/ElasticsearchConfigurations.java

@@ -26,7 +26,7 @@
 public enum ElasticsearchConfigurations implements Supplier<String> {
 
     /**
-     * Database's host. It is a prefix to enumerate hosts. E.g.: elasticsearch.host.1=172.17.0.2:1234
+     * Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.elasticsearch.host.1=172.17.0.2:1234
      */
     HOST("jnosql.elasticsearch.host"),
     /**

jnosql-hazelcast-driver/src/main/java/org/eclipse/jnosql/communication/hazelcast/keyvalue/HazelcastBucketManagerFactory.java

@@ -28,6 +28,14 @@
  */
 public interface HazelcastBucketManagerFactory extends BucketManagerFactory {
 
+    /**
+     * Return the {@link HazelcastBucketManager} instance
+     * @param bucket the function argument
+     * @return the {@link HazelcastBucketManager} instance
+     * @throws NullPointerException when the bucket is null
+     */
+    @Override
+    HazelcastBucketManager apply(String bucket);
     /**
      * Creates a {@link List} from bucket name
      *

jnosql-hazelcast-driver/src/main/java/org/eclipse/jnosql/communication/hazelcast/keyvalue/HazelcastConfigurations.java

@@ -32,7 +32,7 @@ public enum HazelcastConfigurations implements Supplier<String> {
      */
     INSTANCE("jnosql.hazelcast.instance.name"),
     /**
-     * Database's host. It is a prefix to enumerate hosts. E.g.: hazelcast.host.1=localhost
+     * Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.hazelcast.host.1=localhost
      */
     HOST("jnosql.hazelcast.host"),
     /**

jnosql-hbase-driver/src/main/java/org/eclipse/jnosql/communication/hbase/column/HbaseConfigurations.java

@@ -27,7 +27,7 @@ public enum  HbaseConfigurations implements Supplier<String> {
 
 
     /**
-     * The Column family prefixes. E.g.: hbase.family.1=FAMILY
+     * The Column family prefixes. E.g.: jnosql.hbase.family.1=FAMILY
      */
     FAMILY("jnosql.hbase.family");
 

jnosql-infinispan-driver/src/main/java/org/eclipse/jnosql/communication/infinispan/keyvalue/InfinispanConfigurations.java

@@ -26,11 +26,11 @@
 public enum InfinispanConfigurations implements Supplier<String> {
 
     /**
-     * Database's host. It is a prefix to enumerate hosts. E.g.: infinispan.host.1=HOST
+     * Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.infinispan.host.1=HOST
      */
     HOST("jnosql.infinispan.host"),
     /**
-     * The Infinispan configuration path. E.g.: infinispan.config=infinispan.xml
+     * The Infinispan configuration path. E.g.: jnosql.infinispan.config=infinispan.xml
      */
     CONFIG("jnosql.infinispan.config");
 

jnosql-memcached-driver/src/main/java/org/eclipse/jnosql/communication/memcached/keyvalue/MemcachedConfigurations.java

@@ -79,7 +79,7 @@ public enum MemcachedConfigurations implements Supplier<String> {
      */
     PASSWORD("jnosql.memcached.password"),
     /**
-     * Database's host. It is a prefix to enumerate hosts. E.g.: memcached.host.1=localhost:11211
+     * Database's host. It is a prefix to enumerate hosts. E.g.: jnosql.memcached.host.1=localhost:11211
      */
     HOST("jnosql.memcached.host");