Author: wspeirs Date: Mon Nov 21 15:55:41 2011 New Revision: 1204562 URL: http://svn.apache.org/viewvc?rev=1204562&view=rev Log: DBUTILS-77: Updated the documentation as the library works correctly why bypassing ParameterMetaData()
Modified: commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryRunner.java Modified: commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java?rev=1204562&r1=1204561&r2=1204562&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java (original) +++ commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java Mon Nov 21 15:55:41 2011 @@ -56,8 +56,8 @@ public abstract class AbstractQueryRunne } /** - * Constructor to allow workaround for Oracle drivers - * @param pmdKnownBroken Oracle drivers don't support {@link ParameterMetaData#getParameterType(int) }; + * Constructor to control the use of <code>ParameterMetaData</code>. + * @param pmdKnownBroken Some drivers don't support {@link ParameterMetaData#getParameterType(int) }; * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if false, we'll try it, * and if it breaks, we'll remember not to use it again. */ @@ -78,12 +78,12 @@ public abstract class AbstractQueryRunne } /** - * Constructor to allow workaround for Oracle drivers. Methods that do not take a - * <code>Connection</code> parameter will retrieve connections from this + * Constructor to provide a <code>DataSource</code> and control the use of <code>ParameterMetaData</code>. + * Methods that do not take a <code>Connection</code> parameter will retrieve connections from this * <code>DataSource</code>. * * @param ds The <code>DataSource</code> to retrieve connections from. - * @param pmdKnownBroken Oracle drivers don't support {@link ParameterMetaData#getParameterType(int) }; + * @param pmdKnownBroken Some drivers don't support {@link ParameterMetaData#getParameterType(int) }; * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if false, we'll try it, * and if it breaks, we'll remember not to use it again. */ @@ -105,7 +105,7 @@ public abstract class AbstractQueryRunne } /** - * Oracle drivers don't support {@link ParameterMetaData#getParameterType(int) }; + * Some drivers don't support {@link ParameterMetaData#getParameterType(int) }; * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if false, we'll try it, * and if it breaks, we'll remember not to use it again. * Modified: commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java?rev=1204562&r1=1204561&r2=1204562&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java (original) +++ commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/AsyncQueryRunner.java Mon Nov 21 15:55:41 2011 @@ -47,8 +47,9 @@ public class AsyncQueryRunner extends Ab } /** - * Constructor for AsyncQueryRunner, allows workaround for Oracle drivers - * @param pmdKnownBroken Oracle drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int) }; + * Constructor for AsyncQueryRunner that controls the use of <code>ParameterMetaData</code>. + * + * @param pmdKnownBroken Some drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int) }; * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if false, we'll try it, * and if it breaks, we'll remember not to use it again. * @param executorService the {@code ExecutorService} instance used to run JDBC invocations concurrently. @@ -58,8 +59,9 @@ public class AsyncQueryRunner extends Ab } /** - * Constructor for AsyncQueryRunner which takes a <code>DataSource</code>. Methods that do not take a - * <code>Connection</code> parameter will retrieve connections from this + * Constructor for AsyncQueryRunner that takes a <code>DataSource</code>. + * + * Methods that do not take a <code>Connection</code> parameter will retrieve connections from this * <code>DataSource</code>. * * @param ds The <code>DataSource</code> to retrieve connections from. @@ -70,12 +72,12 @@ public class AsyncQueryRunner extends Ab } /** - * Constructor for QueryRunner, allows workaround for Oracle drivers. Methods that do not take a - * <code>Connection</code> parameter will retrieve connections from this + * Constructor for AsyncQueryRunner that take a <code>DataSource</code> to use and controls the use of <code>ParameterMetaData</code>. + * Methods that do not take a <code>Connection</code> parameter will retrieve connections from this * <code>DataSource</code>. * * @param ds The <code>DataSource</code> to retrieve connections from. - * @param pmdKnownBroken Oracle drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int) }; + * @param pmdKnownBroken Some drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int) }; * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if false, we'll try it, * and if it breaks, we'll remember not to use it again. * @param executorService the {@code ExecutorService} instance used to run JDBC invocations concurrently. Modified: commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryRunner.java URL: http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryRunner.java?rev=1204562&r1=1204561&r2=1204562&view=diff ============================================================================== --- commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryRunner.java (original) +++ commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryRunner.java Mon Nov 21 15:55:41 2011 @@ -39,9 +39,9 @@ public class QueryRunner extends Abstrac } /** - * Constructor for QueryRunner, allows workaround for Oracle drivers - * @param pmdKnownBroken Oracle drivers don't support - * {@link java.sql.ParameterMetaData#getParameterType(int) }; + * Constructor for QueryRunner that controls the use of <code>ParameterMetaData</code>. + * + * @param pmdKnownBroken Some drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int) }; * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if false, we'll try it, * and if it breaks, we'll remember not to use it again. */ @@ -50,8 +50,9 @@ public class QueryRunner extends Abstrac } /** - * Constructor for QueryRunner which takes a <code>DataSource</code>. Methods that do not take a - * <code>Connection</code> parameter will retrieve connections from this + * Constructor for QueryRunner that takes a <code>DataSource</code> to use. + * + * Methods that do not take a <code>Connection</code> parameter will retrieve connections from this * <code>DataSource</code>. * * @param ds The <code>DataSource</code> to retrieve connections from. @@ -61,12 +62,12 @@ public class QueryRunner extends Abstrac } /** - * Constructor for QueryRunner, allows workaround for Oracle drivers. Methods that do not take a - * <code>Connection</code> parameter will retrieve connections from this + * Constructor for QueryRunner that takes a <code>DataSource</code> to use and controls the use of <code>ParameterMetaData</code>. + * Methods that do not take a <code>Connection</code> parameter will retrieve connections from this * <code>DataSource</code>. * * @param ds The <code>DataSource</code> to retrieve connections from. - * @param pmdKnownBroken Oracle drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int) }; + * @param pmdKnownBroken Some drivers don't support {@link java.sql.ParameterMetaData#getParameterType(int) }; * if <code>pmdKnownBroken</code> is set to true, we won't even try it; if false, we'll try it, * and if it breaks, we'll remember not to use it again. */