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 2014/07/20 08:24:43 UTC

svn commit: r1612029 - in /commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2: ./ cpdsadapter/ datasources/

Author: ggregory
Date: Sun Jul 20 06:24:43 2014
New Revision: 1612029

URL: http://svn.apache.org/r1612029
Log:
Use the more modern, compact, and flexible Javadoc "{@code ...}" instead of the HTML "<tt>...</tt>".

Modified:
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java
    commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/package-info.java

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingConnection.java Sun Jul 20 06:24:43 2014
@@ -163,17 +163,17 @@ public class DelegatingConnection<C exte
 
     /**
      * If my underlying {@link Connection} is not a
-     * <tt>DelegatingConnection</tt>, returns it,
+     * {@code DelegatingConnection}, returns it,
      * otherwise recursively invokes this method on
      * my delegate.
      * <p>
      * Hence this method will return the first
-     * delegate that is not a <tt>DelegatingConnection</tt>,
-     * or <tt>null</tt> when no non-<tt>DelegatingConnection</tt>
+     * delegate that is not a {@code DelegatingConnection},
+     * or {@code null} when no non-{@code DelegatingConnection}
      * delegate can be found by traversing this chain.
      * <p>
      * This method is useful when you may have nested
-     * <tt>DelegatingConnection</tt>s, and you want to make
+     * {@code DelegatingConnection}s, and you want to make
      * sure to obtain a "genuine" {@link Connection}.
      */
     public Connection getInnermostDelegate() {

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingDatabaseMetaData.java Sun Jul 20 06:24:43 2014
@@ -52,17 +52,17 @@ public class DelegatingDatabaseMetaData 
 
     /**
      * If my underlying {@link ResultSet} is not a
-     * <tt>DelegatingResultSet</tt>, returns it,
+     * {@code DelegatingResultSet}, returns it,
      * otherwise recursively invokes this method on
      * my delegate.
      * <p>
      * Hence this method will return the first
-     * delegate that is not a <tt>DelegatingResultSet</tt>,
-     * or <tt>null</tt> when no non-<tt>DelegatingResultSet</tt>
+     * delegate that is not a {@code DelegatingResultSet},
+     * or {@code null} when no non-{@code DelegatingResultSet}
      * delegate can be found by transversing this chain.
      * <p>
      * This method is useful when you may have nested
-     * <tt>DelegatingResultSet</tt>s, and you want to make
+     * {@code DelegatingResultSet}s, and you want to make
      * sure to obtain a "genuine" {@link ResultSet}.
      */
     public DatabaseMetaData getInnermostDelegate() {

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingResultSet.java Sun Jul 20 06:24:43 2014
@@ -122,17 +122,17 @@ public final class DelegatingResultSet e
 
     /**
      * If my underlying {@link ResultSet} is not a
-     * <tt>DelegatingResultSet</tt>, returns it,
+     * {@code DelegatingResultSet}, returns it,
      * otherwise recursively invokes this method on
      * my delegate.
      * <p>
      * Hence this method will return the first
-     * delegate that is not a <tt>DelegatingResultSet</tt>,
-     * or <tt>null</tt> when no non-<tt>DelegatingResultSet</tt>
+     * delegate that is not a {@code DelegatingResultSet},
+     * or {@code null} when no non-{@code DelegatingResultSet}
      * delegate can be found by transversing this chain.
      * <p>
      * This method is useful when you may have nested
-     * <tt>DelegatingResultSet</tt>s, and you want to make
+     * {@code DelegatingResultSet}s, and you want to make
      * sure to obtain a "genuine" {@link ResultSet}.
      */
     public ResultSet getInnermostDelegate() {

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/DelegatingStatement.java Sun Jul 20 06:24:43 2014
@@ -75,17 +75,17 @@ public class DelegatingStatement extends
 
     /**
      * If my underlying {@link Statement} is not a
-     * <tt>DelegatingStatement</tt>, returns it,
+     * {@code DelegatingStatement}, returns it,
      * otherwise recursively invokes this method on
      * my delegate.
      * <p>
      * Hence this method will return the first
-     * delegate that is not a <tt>DelegatingStatement</tt>
-     * or <tt>null</tt> when no non-<tt>DelegatingStatement</tt>
+     * delegate that is not a {@code DelegatingStatement}
+     * or {@code null} when no non-{@code DelegatingStatement}
      * delegate can be found by transversing this chain.
      * <p>
      * This method is useful when you may have nested
-     * <tt>DelegatingStatement</tt>s, and you want to make
+     * {@code DelegatingStatement}s, and you want to make
      * sure to obtain a "genuine" {@link Statement}.
      * @see #getDelegate
      */

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolableConnectionFactory.java Sun Jul 20 06:24:43 2014
@@ -53,7 +53,7 @@ public class PoolableConnectionFactory
             LogFactory.getLog(PoolableConnectionFactory.class);
 
     /**
-     * Create a new <tt>PoolableConnectionFactory</tt>.
+     * Create a new {@code PoolableConnectionFactory}.
      * @param connFactory the {@link ConnectionFactory} from which to obtain
      * base {@link Connection}s
      */
@@ -88,7 +88,7 @@ public class PoolableConnectionFactory
 
     /**
      * Sets the SQL statements I use to initialize newly created {@link Connection}s.
-     * Using <tt>null</tt> turns off connection initialization.
+     * Using {@code null} turns off connection initialization.
      * @param connectionInitSqls SQL statement to initialize {@link Connection}s.
      */
     public void setConnectionInitSql(Collection<String> connectionInitSqls) {

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/PoolingConnection.java Sun Jul 20 06:24:43 2014
@@ -365,7 +365,7 @@ public class PoolingConnection extends D
      *
      * @param key ignored
      * @param p ignored
-     * @return <tt>true</tt>
+     * @return {@code true}
      */
     @Override
     public boolean validateObject(PStmtKey key,

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/cpdsadapter/PooledConnectionImpl.java Sun Jul 20 06:24:43 2014
@@ -462,7 +462,7 @@ class PooledConnectionImpl implements Po
      * {*link PreparedStatement}s.
      * @param key ignored
      * @param p ignored
-     * @return <tt>true</tt>
+     * @return {@code true}
      */
     @Override
     public boolean validateObject(PStmtKeyCPDS key,

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/CPDSConnectionFactory.java Sun Jul 20 06:24:43 2014
@@ -76,13 +76,13 @@ class CPDSConnectionFactory
         new ConcurrentHashMap<>();
 
     /**
-     * Create a new <tt>PoolableConnectionFactory</tt>.
+     * Create a new {@code PoolableConnectionFactory}.
      *
      * @param cpds the ConnectionPoolDataSource from which to obtain
      * PooledConnection's
      * @param validationQuery a query to use to {@link #validateObject
      * validate} {@link Connection}s. Should return at least one row.
-     * May be <tt>null</tt> in which case {@link Connection#isValid(int)} will
+     * May be {@code null} in which case {@link Connection#isValid(int)} will
      * be used to validate connections.
      * @param validationQueryTimeout Timeout in seconds before validation fails
      * @param rollbackAfterValidation whether a rollback should be issued

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java Sun Jul 20 06:24:43 2014
@@ -75,12 +75,12 @@ class KeyedCPDSConnectionFactory
 
 
     /**
-     * Create a new <tt>KeyedPoolableConnectionFactory</tt>.
+     * Create a new {@code KeyedPoolableConnectionFactory}.
      * @param cpds the ConnectionPoolDataSource from which to obtain
      * PooledConnections
      * @param validationQuery a query to use to {@link #validateObject validate}
      * {@link Connection}s.  Should return at least one row. May be
-     * <tt>null</tt> in which case3 {@link Connection#isValid(int)} will be used
+     * {@code null} in which case3 {@link Connection#isValid(int)} will be used
      * to validate connections.
      * @param rollbackAfterValidation whether a rollback should be issued after
      * {@link #validateObject validating} {@link Connection}s.

Modified: commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/package-info.java?rev=1612029&r1=1612028&r2=1612029&view=diff
==============================================================================
--- commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/package-info.java (original)
+++ commons/proper/dbcp/trunk/src/main/java/org/apache/commons/dbcp2/package-info.java Sun Jul 20 06:24:43 2014
@@ -114,7 +114,7 @@
  *    To create a {@link org.apache.commons.dbcp2.PoolingDriver}, we do the same thing,
  *    except that instead of creating a {@link javax.sql.DataSource} on the last line,
  *    we create a {@link org.apache.commons.dbcp2.PoolingDriver}, and register the
- *    <tt>connectionPool</tt> with it.  E.g.,:
+ *    {@code connectionPool} with it.  E.g.,:
  * <pre>GenericObjectPool connectionPool = new GenericObjectPool(null);
  * ConnectionFactory connectionFactory = new DriverManagerConnectionFactory("jdbc:some:connect:string", "username", "password");
  * PoolableConnectionFactory poolableConnectionFactory = new PoolableConnectionFactory(connectionFactory,connectionPool,null,null,false,true);