You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2019/07/30 18:25:05 UTC

[commons-dbcp] 02/13: Javadoc.

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

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbcp.git

commit bdc56975dc63401fa40e2d645ad57ddf32c5230b
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Jul 30 09:56:27 2019 -0400

    Javadoc.
---
 .../dbcp2/datasources/InstanceKeyDataSource.java       | 18 +++++++++---------
 .../datasources/InstanceKeyDataSourceFactory.java      |  2 +-
 src/test/java/org/apache/commons/dbcp2/TestJndi.java   | 12 ++++++------
 3 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java
index 1b070cc..13c0cab 100644
--- a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java
+++ b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java
@@ -98,7 +98,7 @@ public abstract class InstanceKeyDataSource implements DataSource, Referenceable
     /** Description */
     private String description;
 
-    /** Environment that may be used to set up a jndi initial context. */
+    /** Environment that may be used to set up a JNDI initial context. */
     private Properties jndiEnvironment;
 
     /** Login TimeOut in seconds */
@@ -520,8 +520,8 @@ public abstract class InstanceKeyDataSource implements DataSource, Referenceable
     }
 
     /**
-     * Gets the value of connectionPoolDataSource. This method will return null, if the backing datasource is being
-     * accessed via jndi.
+     * Gets the value of connectionPoolDataSource. This method will return null, if the backing data source is being
+     * accessed via JNDI.
      *
      * @return value of connectionPoolDataSource.
      */
@@ -530,8 +530,8 @@ public abstract class InstanceKeyDataSource implements DataSource, Referenceable
     }
 
     /**
-     * Sets the backend ConnectionPoolDataSource. This property should not be set if using jndi to access the
-     * datasource.
+     * Sets the backend ConnectionPoolDataSource. This property should not be set if using JNDI to access the
+     * data source.
      *
      * @param v
      *            Value to assign to connectionPoolDataSource.
@@ -549,8 +549,8 @@ public abstract class InstanceKeyDataSource implements DataSource, Referenceable
     }
 
     /**
-     * Gets the name of the ConnectionPoolDataSource which backs this pool. This name is used to look up the datasource
-     * from a jndi service provider.
+     * Gets the name of the ConnectionPoolDataSource which backs this pool. This name is used to look up the data source
+     * from a JNDI service provider.
      *
      * @return value of dataSourceName.
      */
@@ -559,8 +559,8 @@ public abstract class InstanceKeyDataSource implements DataSource, Referenceable
     }
 
     /**
-     * Sets the name of the ConnectionPoolDataSource which backs this pool. This name is used to look up the datasource
-     * from a jndi service provider.
+     * Sets the name of the ConnectionPoolDataSource which backs this pool. This name is used to look up the data source
+     * from a JNDI service provider.
      *
      * @param v
      *            Value to assign to dataSourceName.
diff --git a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSourceFactory.java b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSourceFactory.java
index ee68cd7..f6ee923 100644
--- a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSourceFactory.java
+++ b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSourceFactory.java
@@ -120,7 +120,7 @@ abstract class InstanceKeyDataSourceFactory implements ObjectFactory {
             if (isCorrectClass(ref.getClassName())) {
                 final RefAddr refAddr = ref.get("instanceKey");
                 if (refAddr != null && refAddr.getContent() != null) {
-                    // object was bound to jndi via Referenceable api.
+                    // object was bound to JNDI via Referenceable API.
                     obj = instanceMap.get(refAddr.getContent());
                 } else {
                     // Tomcat JNDI creates a Reference out of server.xml
diff --git a/src/test/java/org/apache/commons/dbcp2/TestJndi.java b/src/test/java/org/apache/commons/dbcp2/TestJndi.java
index fbaef4c..8121174 100644
--- a/src/test/java/org/apache/commons/dbcp2/TestJndi.java
+++ b/src/test/java/org/apache/commons/dbcp2/TestJndi.java
@@ -43,12 +43,12 @@ public class TestJndi {
     protected static final String JNDI_SUBCONTEXT = "jdbc";
 
     /**
-     * the full jndi path to the data source.
+     * the full JNDI path to the data source.
      */
     protected static final String JNDI_PATH = JNDI_SUBCONTEXT + "/"
             + "jndiTestDataSource";
 
-    /** jndi context to use in tests **/
+    /** JNDI context to use in tests **/
     protected Context context = null;
 
     /**
@@ -97,7 +97,7 @@ public class TestJndi {
     }
 
     /**
-     * Binds a DataSource to the jndi and checks that we have successfully
+     * Binds a DataSource to the JNDI and checks that we have successfully
      * bound it by looking it up again.
      *
      * @throws Exception if the bind, lookup or connect fails
@@ -108,7 +108,7 @@ public class TestJndi {
     }
 
     /**
-     * Binds a DataSource into jndi.
+     * Binds a DataSource into JNDI.
      *
      * @throws Exception if creation or binding fails.
      */
@@ -117,9 +117,9 @@ public class TestJndi {
     }
 
     /**
-     * Retrieves a DataSource from jndi.
+     * Retrieves a DataSource from JNDI.
      *
-     * @throws Exception if the jndi lookup fails or no DataSource is bound.
+     * @throws Exception if the JNDI lookup fails or no DataSource is bound.
      */
     protected DataSource retrieveDataSource() throws Exception {
         final Context ctx = getInitialContext();