JDBC 3.0 related javadoc overhaul

Issue: SPR-11600

Author: jhoeller

spring-jdbc/src/main/java/org/springframework/jdbc/core/metadata/HsqlTableMetaDataProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,8 +20,9 @@
 import java.sql.SQLException;
 
 /**
- * The HSQL specific implementation of the {@link TableMetaDataProvider}.
- * Supports a feature for retreiving generated keys without the JDBC 3.0 getGeneratedKeys support.
+ * The HSQL specific implementation of {@link TableMetaDataProvider}.
+ * Supports a feature for retrieving generated keys without the JDBC 3.0
+ * {@code getGeneratedKeys} support.
  *
  * @author Thomas Risberg
  * @since 2.5

spring-jdbc/src/main/java/org/springframework/jdbc/core/metadata/PostgresTableMetaDataProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,8 +20,9 @@
 import java.sql.SQLException;
 
 /**
- * The PostgreSQL specific implementation of the {@link org.springframework.jdbc.core.metadata.TableMetaDataProvider}.
- * Suports a feature for retreiving generated keys without the JDBC 3.0 getGeneratedKeys support.
+ * The PostgreSQL specific implementation of {@link TableMetaDataProvider}.
+ * Supports a feature for retrieving generated keys without the JDBC 3.0
+ * {@code getGeneratedKeys} support.
  *
  * @author Thomas Risberg
  * @since 2.5
@@ -38,7 +39,10 @@ public boolean isGetGeneratedKeysSimulated() {
 			return true;
 		}
 		else {
-			logger.warn("PostgreSQL does not support getGeneratedKeys or INSERT ... RETURNING in version " + getDatabaseVersion());
+			if (logger.isWarnEnabled()) {
+				logger.warn("PostgreSQL does not support getGeneratedKeys or INSERT ... RETURNING in version " +
+						getDatabaseVersion());
+			}
 			return false;
 		}
 	}
@@ -47,4 +51,5 @@ public boolean isGetGeneratedKeysSimulated() {
 	public String getSimpleQueryForGetGeneratedKey(String tableName, String keyColumnName) {
 		return "RETURNING " + keyColumnName;
 	}
+
 }

spring-jdbc/src/main/java/org/springframework/jdbc/datasource/DataSourceTransactionManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,10 +33,9 @@
  * {@link org.springframework.transaction.PlatformTransactionManager}
  * implementation for a single JDBC {@link javax.sql.DataSource}. This class is
  * capable of working in any environment with any JDBC driver, as long as the setup
- * uses a JDBC 2.0 Standard Extensions / JDBC 3.0 {@code javax.sql.DataSource}
- * as its Connection factory mechanism. Binds a JDBC Connection from the specified
- * DataSource to the current thread, potentially allowing for one thread-bound
- * Connection per DataSource.
+ * uses a {@code javax.sql.DataSource} as its {@code Connection} factory mechanism.
+ * Binds a JDBC Connection from the specified DataSource to the current thread,
+ * potentially allowing for one thread-bound Connection per DataSource.
  *
  * <p><b>Note: The DataSource that this transaction manager operates on needs
  * to return independent Connections.</b> The Connections may come from a pool
@@ -75,8 +74,8 @@
  * an actual JDBC Connection from the target DataSource until a Statement gets executed,
  * lazily applying the specified transaction settings to the target Connection.
  *
- * <p>On JDBC 3.0, this transaction manager supports nested transactions via the
- * JDBC 3.0 {@link java.sql.Savepoint} mechanism. The
+ * <p>This transaction manager supports nested transactions via the JDBC 3.0
+ * {@link java.sql.Savepoint} mechanism. The
  * {@link #setNestedTransactionAllowed "nestedTransactionAllowed"} flag defaults
  * to "true", since nested transactions will work without restrictions on JDBC
  * drivers that support savepoints (such as the Oracle JDBC driver).

spring-jdbc/src/main/java/org/springframework/jdbc/object/StoredProcedure.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,8 +16,8 @@
 
 package org.springframework.jdbc.object;
 
-import java.util.Map;
 import java.util.HashMap;
+import java.util.Map;
 import javax.sql.DataSource;
 
 import org.springframework.dao.DataAccessException;
@@ -33,9 +33,7 @@
  * {@link #execute} method.
  *
  * <p>The inherited {@code sql} property is the name of the stored
- * procedure in the RDBMS. Note that JDBC 3.0 introduces named parameters,
- * although the other features provided by this class are still necessary
- * in JDBC 3.0.
+ * procedure in the RDBMS.
  *
  * @author Rod Johnson
  * @author Thomas Risberg

spring-jdbc/src/main/java/org/springframework/jdbc/support/incrementer/DerbyMaxValueIncrementer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,7 +20,6 @@
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Statement;
-
 import javax.sql.DataSource;
 
 import org.springframework.dao.DataAccessException;
@@ -51,7 +50,7 @@
  * is rolled back, the unused values will never be served. The maximum hole size in
  * numbering is consequently the value of cacheSize.
  *
- * <b>HINT:</b>  Since Derby supports the JDBC 3.0 {@code getGeneratedKeys} method,
+ * <b>HINT:</b> Since Derby supports the JDBC 3.0 {@code getGeneratedKeys} method,
  * it is recommended to use IDENTITY columns directly in the tables and then utilizing
  * a {@link org.springframework.jdbc.support.KeyHolder} when calling the with the
  * {@code update(PreparedStatementCreator psc, KeyHolder generatedKeyHolder)}

spring-jdbc/src/main/java/org/springframework/jdbc/support/incrementer/SqlServerMaxValueIncrementer.java

@@ -1,16 +1,32 @@
+/*
+ * Copyright 2002-2014 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package org.springframework.jdbc.support.incrementer;
 
+import java.sql.Connection;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Statement;
+import javax.sql.DataSource;
+
 import org.springframework.dao.DataAccessException;
 import org.springframework.dao.DataAccessResourceFailureException;
 import org.springframework.jdbc.datasource.DataSourceUtils;
 import org.springframework.jdbc.support.JdbcUtils;
 
-import javax.sql.DataSource;
-import java.sql.Connection;
-import java.sql.Statement;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-
 /**
  * {@link DataFieldMaxValueIncrementer} that increments the maximum value of a given SQL Server table
  * with the equivalent of an auto-increment column. Note: If you use this class, your Derby key
@@ -32,8 +48,8 @@
  * is rolled back, the unused values will never be served. The maximum hole size in
  * numbering is consequently the value of cacheSize.
  *
- * <b>HINT:</b>  Since Microsoft SQL Server supports the JDBC 3.0 {@code getGeneratedKeys} method,
- * it is recommended to use IDENTITY columns directly in the tables and then using a
+ * <b>HINT:</b> Since Microsoft SQL Server supports the JDBC 3.0 {@code getGeneratedKeys}
+ * method, it is recommended to use IDENTITY columns directly in the tables and then using a
  * {@link org.springframework.jdbc.core.simple.SimpleJdbcInsert} or utilizing
  * a {@link org.springframework.jdbc.support.KeyHolder} when calling the with the
  * {@code update(PreparedStatementCreator psc, KeyHolder generatedKeyHolder)}

spring-jdbc/src/main/java/org/springframework/jdbc/support/incrementer/SybaseAnywhereMaxValueIncrementer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@
  * is rolled back, the unused values will never be served. The maximum hole size in
  * numbering is consequently the value of cacheSize.
  *
- * <b>HINT:</b>  Since Sybase Anywhere supports the JDBC 3.0 {@code getGeneratedKeys} method,
+ * <b>HINT:</b> Since Sybase Anywhere supports the JDBC 3.0 {@code getGeneratedKeys} method,
  * it is recommended to use IDENTITY columns directly in the tables and then using a
  * {@link org.springframework.jdbc.core.simple.SimpleJdbcInsert} or utilizing
  * a {@link org.springframework.jdbc.support.KeyHolder} when calling the with the

spring-jdbc/src/main/java/org/springframework/jdbc/support/incrementer/SybaseMaxValueIncrementer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,17 +16,17 @@
 
 package org.springframework.jdbc.support.incrementer;
 
+import java.sql.Connection;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Statement;
+import javax.sql.DataSource;
+
 import org.springframework.dao.DataAccessException;
 import org.springframework.dao.DataAccessResourceFailureException;
 import org.springframework.jdbc.datasource.DataSourceUtils;
 import org.springframework.jdbc.support.JdbcUtils;
 
-import javax.sql.DataSource;
-import java.sql.Connection;
-import java.sql.Statement;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-
 /**
  * {@link DataFieldMaxValueIncrementer} that increments
  * the maximum value of a given Sybase SQL Server table
@@ -49,7 +49,7 @@
  * is rolled back, the unused values will never be served. The maximum hole size in
  * numbering is consequently the value of cacheSize.
  *
- * <b>HINT:</b>  Since Sybase supports the JDBC 3.0 {@code getGeneratedKeys} method,
+ * <b>HINT:</b> Since Sybase supports the JDBC 3.0 {@code getGeneratedKeys} method,
  * it is recommended to use IDENTITY columns directly in the tables and then using a
  * {@link org.springframework.jdbc.core.simple.SimpleJdbcInsert} or utilizing
  * a {@link org.springframework.jdbc.support.KeyHolder} when calling the with the
@@ -133,8 +133,8 @@ protected synchronized long getNextKey() throws DataAccessException {
 	}
 
 	/**
-	 * Statement to use to increment the "sequence" value. Can be overridden by sub-classes.
-	 * @return The SQL statement to use
+	 * Statement to use to increment the "sequence" value. Can be overridden by subclasses.
+	 * @return the SQL statement to use
 	 */
 	protected String getIncrementStatement() {
 		return "insert into " + getIncrementerName() + " values()";