Javadoc fixes

2.3.0
Brett Wooldridge 10 years ago
parent 1067111883
commit c9f6d90ab2

@ -173,7 +173,7 @@ public class ConcurrentBag<T extends AbstractBagEntry>
/**
* Remove a value from the bag. This method should only be called
* with objects obtained by <code>borrow(long, TimeUnit)<code> or <code>reserve(T)</code>
* with objects obtained by <code>borrow(long, TimeUnit)</code> or <code>reserve(T)</code>
*
* @param bagEntry the value to remove
* @return true if the entry was removed, false otherwise

@ -44,6 +44,7 @@ public final class PoolUtilities
*
* @param connection the connection to initialize
* @param sql the SQL to execute
* @param isAutoCommit whether to commit the SQL after execution or not
* @throws SQLException throws if the init SQL execution fails
*/
public void executeSql(final Connection connection, final String sql, final boolean isAutoCommit) throws SQLException
@ -65,7 +66,13 @@ public final class PoolUtilities
/**
* Create/initialize the underlying DataSource.
*
* @return the DataSource
* @param dsClassName a DataSource class name (optional)
* @param dataSource a DataSource instance (optional)
* @param dataSourceProperties a Properties instance of DataSource properties
* @param jdbcUrl a JDBC connection URL (optional)
* @param username a username (optional)
* @param password a password (optional)
* @return a DataSource instance
*/
public DataSource initializeDataSource(final String dsClassName, DataSource dataSource, final Properties dataSourceProperties, final String jdbcUrl, final String username, final String password)
{

@ -91,6 +91,7 @@ public final class UtilityElf
* @param className the name of the classto instantiate
* @param clazz a class to cast the result as
* @param args arguments to a constructor
* @param T the class type
* @return an instance of the specified class
*/
@SuppressWarnings("unchecked")
@ -126,6 +127,7 @@ public final class UtilityElf
* @param queueSize the queue size
* @param threadName the thread name
* @param threadFactory an optional ThreadFactory
* @param policy the RejectedExecutionHandler policy
* @return a ThreadPoolExecutor
*/
public static ThreadPoolExecutor createThreadPoolExecutor(final int queueSize, final String threadName, ThreadFactory threadFactory, final RejectedExecutionHandler policy)

@ -61,7 +61,7 @@ public final class Java6ConcurrentBag extends ConcurrentBag<PoolBagEntry>
/**
* This method provides a "snaphot" in time of the BagEntry
* items in the bag in the specified state. It does not "lock"
* or reserve items in any way. Call {@link #reserve(BagEntry)}
* or reserve items in any way. Call <code>reserve(BagEntry)</code>
* on items in list before performing any action on them.
*
* @param state one of STATE_NOT_IN_USE or STATE_IN_USE

@ -66,7 +66,7 @@ public final class Java8ConcurrentBag extends ConcurrentBag<PoolBagEntry>
/**
* This method provides a "snaphot" in time of the BagEntry
* items in the bag in the specified state. It does not "lock"
* or reserve items in any way. Call {@link #reserve(BagEntry)}
* or reserve items in any way. Call <code>reserve(BagEntry)</code>
* on items in list before performing any action on them.
*
* @param state one of STATE_NOT_IN_USE or STATE_IN_USE

Loading…
Cancel
Save