You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gora.apache.org by dr...@apache.org on 2020/03/23 21:01:35 UTC

[gora] 03/07: GORA-649 MongoStoreParameters: improve Javadoc

This is an automated email from the ASF dual-hosted git repository.

drazzib pushed a commit to branch GORA-649-replace-deprecated-mongo-api
in repository https://gitbox.apache.org/repos/asf/gora.git

commit 0128a100a6dbbf50af8f7a3694cb6ee3064912f6
Author: Damien Raude-Morvan <dr...@drazzib.com>
AuthorDate: Mon Mar 23 21:55:05 2020 +0100

    GORA-649 MongoStoreParameters: improve Javadoc
---
 .../org/apache/gora/mongodb/store/MongoStoreParameters.java   | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java b/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java
index b278b89..e939785 100644
--- a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java
+++ b/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java
@@ -17,7 +17,6 @@
  */
 package org.apache.gora.mongodb.store;
 
-import com.mongodb.DB;
 import org.apache.hadoop.conf.Configuration;
 
 import java.util.Properties;
@@ -92,14 +91,14 @@ public class MongoStoreParameters {
   private final String writeConcern;
 
   /**
-   * @param mappingFile
-   * @param servers
+   * @param mappingFile    Configuration file for mapping.
+   * @param servers        Collection of seeds servers.
    * @param dbname         Name of database to connect to.
    * @param authenticationType Authentication type to login
-   * @param login          Optionnal login for remote database.
+   * @param login          Optional login for remote database.
    * @param secret         Optional secret for remote database.
-   * @param readPreference
-   * @param writeConcern   @return a {@link DB} instance from <tt>mongoClient</tt> or null if
+   * @param readPreference Optional {@link com.mongodb.ReadPreference}.
+   * @param writeConcern   Optional {@link com.mongodb.WriteConcern}.
    */
   private MongoStoreParameters(String mappingFile, String servers, String dbname, String authenticationType, String login, String secret, String readPreference, String writeConcern) {
     this.mappingFile = mappingFile;