stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8178130: Minor update to the Connection javadocs

Browse Source 
Reviewed-by: bpb
This commit is contained in:
Lance Andersen 2017-04-09 14:25:07 -04:00
parent 80eb904ede
commit 5622eecc0a
1 changed files with 29 additions and 19 deletions

48
jdk/src/java.sql/share/classes/java/sql/Connection.java

@ -1535,8 +1535,9 @@ throws SQLException;
* <li>The connection pool caches {@code PooledConnection} objects</li> * <li>The connection pool caches {@code PooledConnection} objects</li>
* <li>Returns a logical connection handle when {@code getConnection} is * <li>Returns a logical connection handle when {@code getConnection} is
* called by the application</li> * called by the application</li>
* <li>The pool manager calls {@code Connection.close} on the logical connection handle * <li>The logical {@code Connection} is closed by calling
* prior to returning the {@code PooledConnection} back to the cache</li> * {@code Connection.close} prior to returning the {@code PooledConnection}
* to the cache.</li>
* </ul> * </ul>
* @throws SQLException if an error occurs * @throws SQLException if an error occurs
* @since 9 * @since 9
@ -1577,8 +1578,9 @@ throws SQLException;
* <li>The connection pool caches {@code PooledConnection} objects</li> * <li>The connection pool caches {@code PooledConnection} objects</li>
* <li>Returns a logical connection handle when {@code getConnection} is * <li>Returns a logical connection handle when {@code getConnection} is
* called by the application</li> * called by the application</li>
* <li>The pool manager calls {@code Connection.close} on the logical connection handle * <li>The logical {@code Connection} is closed by calling
* prior to returning the {@code PooledConnection} back to the cache</li> * {@code Connection.close} prior to returning the {@code PooledConnection}
* to the cache.</li>
* </ul> * </ul>
* @throws SQLException if an error occurs * @throws SQLException if an error occurs
* @since 9 * @since 9
@ -1590,7 +1592,10 @@ throws SQLException;
} }
/** /**
* Sets and validates the sharding keys for this connection. * Sets and validates the sharding keys for this connection. A {@code null}
* value may be specified for the sharding Key. The validity
* of a {@code null} sharding key is vendor-specific. Consult your vendor&#39;s
* documentation for additional information.
* @implSpec * @implSpec
* The default implementation will throw a * The default implementation will throw a
* {@code SQLFeatureNotSupportedException}. * {@code SQLFeatureNotSupportedException}.
@ -1600,7 +1605,8 @@ throws SQLException;
* {@code Connection}. The timeout value indicates how long the driver * {@code Connection}. The timeout value indicates how long the driver
* should wait for the {@code Connection} to verify that the sharding key * should wait for the {@code Connection} to verify that the sharding key
* is valid before {@code setShardingKeyIfValid} returns false. * is valid before {@code setShardingKeyIfValid} returns false.
* @param shardingKey the sharding key to be validated against this connection * @param shardingKey the sharding key to be validated against this connection.
* The sharding key may be {@code null}
* @param superShardingKey the super sharding key to be validated against this * @param superShardingKey the super sharding key to be validated against this
* connection. The super sharding key may be {@code null}. * connection. The super sharding key may be {@code null}.
* @param timeout time in seconds before which the validation process is expected to * @param timeout time in seconds before which the validation process is expected to
@ -1610,10 +1616,10 @@ throws SQLException;
* and set on this connection; false if the sharding keys are not valid or * and set on this connection; false if the sharding keys are not valid or
* the timeout period expires before the operation completes. * the timeout period expires before the operation completes.
* @throws SQLException if an error occurs while performing this validation; * @throws SQLException if an error occurs while performing this validation;
* the {@code shardingkey} is {@code null}; a {@code superSharedingKey} is specified * a {@code superSharedingKey} is specified
* without a {@code shardingKey}; * without a {@code shardingKey};
* this method is called on a closed {@code connection}; or * this method is called on a closed {@code connection}; or
* the {@code timeout} value is less than 0. * the {@code timeout} value is negative.
* @throws SQLFeatureNotSupportedException if the driver does not support sharding * @throws SQLFeatureNotSupportedException if the driver does not support sharding
* @since 9 * @since 9
* @see ShardingKey * @see ShardingKey
@ -1626,7 +1632,10 @@ throws SQLException;
} }
/** /**
* Sets and validates the sharding key for this connection. * Sets and validates the sharding key for this connection. A {@code null}
* value may be specified for the sharding Key. The validity
* of a {@code null} sharding key is vendor-specific. Consult your vendor&#39;s
* documentation for additional information.
* @implSpec * @implSpec
* The default implementation will throw a * The default implementation will throw a
* {@code SQLFeatureNotSupportedException}. * {@code SQLFeatureNotSupportedException}.
@ -1635,7 +1644,8 @@ throws SQLException;
* {@code Connection}. The timeout value indicates how long the driver * {@code Connection}. The timeout value indicates how long the driver
* should wait for the {@code Connection} to verify that the sharding key * should wait for the {@code Connection} to verify that the sharding key
* is valid before {@code setShardingKeyIfValid} returns false. * is valid before {@code setShardingKeyIfValid} returns false.
* @param shardingKey the sharding key to be validated against this connection * @param shardingKey the sharding key to be validated against this connection.
* The sharding key may be {@code null}
* @param timeout time in seconds before which the validation process is expected to * @param timeout time in seconds before which the validation process is expected to
* be completed,else the validation process is aborted. A value of 0 indicates * be completed,else the validation process is aborted. A value of 0 indicates
* the validation process will not time out. * the validation process will not time out.
@ -1643,8 +1653,8 @@ throws SQLException;
* set on this connection; false if the sharding key is not valid or * set on this connection; false if the sharding key is not valid or
* the timeout period expires before the operation completes. * the timeout period expires before the operation completes.
* @throws SQLException if there is an error while performing this validation; * @throws SQLException if there is an error while performing this validation;
* this method is called on a closed {@code connection}; the {@code shardingkey} * this method is called on a closed {@code connection};
* is {@code null}; or the {@code timeout} value is less than 0. * or the {@code timeout} value is negative.
* @throws SQLFeatureNotSupportedException if the driver does not support sharding * @throws SQLFeatureNotSupportedException if the driver does not support sharding
* @since 9 * @since 9
* @see ShardingKey * @see ShardingKey
@ -1664,12 +1674,12 @@ throws SQLException;
* This method sets the specified sharding keys but does not require a * This method sets the specified sharding keys but does not require a
* round trip to the database to validate that the sharding keys are valid * round trip to the database to validate that the sharding keys are valid
* for the {@code Connection}. * for the {@code Connection}.
* @param shardingKey the sharding key to set on this connection. * @param shardingKey the sharding key to set on this connection. The sharding
* key may be {@code null}
* @param superShardingKey the super sharding key to set on this connection. * @param superShardingKey the super sharding key to set on this connection.
* The super sharding key may be {@code null} * The super sharding key may be {@code null}
* @throws SQLException if an error occurs setting the sharding keys; * @throws SQLException if an error occurs setting the sharding keys;
* this method is called on a closed {@code connection}; * this method is called on a closed {@code connection}; or
* the {@code shardingkey} is {@code null}; or
* a {@code superSharedingKey} is specified without a {@code shardingKey} * a {@code superSharedingKey} is specified without a {@code shardingKey}
* @throws SQLFeatureNotSupportedException if the driver does not support sharding * @throws SQLFeatureNotSupportedException if the driver does not support sharding
* @since 9 * @since 9
@ -1690,10 +1700,10 @@ throws SQLException;
* This method sets the specified sharding key but does not require a * This method sets the specified sharding key but does not require a
* round trip to the database to validate that the sharding key is valid * round trip to the database to validate that the sharding key is valid
* for the {@code Connection}. * for the {@code Connection}.
* @param shardingKey the sharding key to set on this connection. * @param shardingKey the sharding key to set on this connection. The sharding
* @throws SQLException if an error occurs setting the sharding key; * key may be {@code null}
* this method is called on a closed {@code connection}; or the * @throws SQLException if an error occurs setting the sharding key; or
* {@code shardkingKey} is {@code null} * this method is called on a closed {@code connection}
* @throws SQLFeatureNotSupportedException if the driver does not support sharding * @throws SQLFeatureNotSupportedException if the driver does not support sharding
* @since 9 * @since 9
* @see ShardingKey * @see ShardingKey