Author: markt
Date: Fri Oct 18 09:50:46 2013
New Revision: 1533373
URL: http://svn.apache.org/r1533373
Log:
More Checkstyle inspired Javadoc fixes
Modified:
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolConfig.java
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolMXBean.java
Modified:
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolConfig.java
URL:
http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolConfig.java?rev=1533373&r1=1533372&r2=1533373&view=diff
==============================================================================
---
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolConfig.java
(original)
+++
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolConfig.java
Fri Oct 18 09:50:46 2013
@@ -31,19 +31,20 @@ package org.apache.commons.pool2.impl;
public class GenericObjectPoolConfig extends BaseObjectPoolConfig {
/**
- * The default maximum number of instances under management
- * (idle or checked out).
+ * The default value for the {@code maxTotal} configuration attribute.
+ * @see GenericObjectPool#getMaxTotal()
*/
public static final int DEFAULT_MAX_TOTAL = 8;
/**
- * The default cap on the number of "sleeping" instances in the pool.
+ * The default value for the {@code maxIdle} configuration attribute.
+ * @see GenericObjectPool#getMaxIdle()
*/
public static final int DEFAULT_MAX_IDLE = 8;
/**
- * The default minimum number of "sleeping" instances in the pool before
- * before the evictor thread (if active) spawns new objects.
+ * The default value for the {@code minIdle} configuration attribute.
+ * @see GenericObjectPool#getMinIdle()
*/
public static final int DEFAULT_MIN_IDLE = 0;
@@ -54,28 +55,82 @@ public class GenericObjectPoolConfig ext
private int minIdle = DEFAULT_MIN_IDLE;
+ /**
+ * Get the value for the {@code maxTotal} configuration attribute
+ * for pools created with this configuration instance.
+ *
+ * @return The current setting of {@code maxTotal} for this
+ * configuration instance
+ *
+ * @see GenericObjectPool#getMaxTotal()
+ */
public int getMaxTotal() {
return maxTotal;
}
+ /**
+ * Set the value for the {@code maxTotal} configuration attribute for
+ * pools created with this configuration instance.
+ *
+ * @param maxTotal The new setting of {@code maxTotal}
+ * for this configuration instance
+ *
+ * @see GenericObjectPool#setMaxTotal(int)
+ */
public void setMaxTotal(int maxTotal) {
this.maxTotal = maxTotal;
}
+ /**
+ * Get the value for the {@code maxIdle} configuration attribute
+ * for pools created with this configuration instance.
+ *
+ * @return The current setting of {@code maxIdle} for this
+ * configuration instance
+ *
+ * @see GenericObjectPool#getMaxIdle()
+ */
public int getMaxIdle() {
return maxIdle;
}
+ /**
+ * Set the value for the {@code maxIdle} configuration attribute for
+ * pools created with this configuration instance.
+ *
+ * @param maxIdle The new setting of {@code maxIdle}
+ * for this configuration instance
+ *
+ * @see GenericObjectPool#setMaxIdle(int)
+ */
public void setMaxIdle(int maxIdle) {
this.maxIdle = maxIdle;
}
+ /**
+ * Get the value for the {@code minIdle} configuration attribute
+ * for pools created with this configuration instance.
+ *
+ * @return The current setting of {@code minIdle} for this
+ * configuration instance
+ *
+ * @see GenericObjectPool#getMinIdle()
+ */
public int getMinIdle() {
return minIdle;
}
+ /**
+ * Set the value for the {@code minIdle} configuration attribute for
+ * pools created with this configuration instance.
+ *
+ * @param minIdle The new setting of {@code minIdle}
+ * for this configuration instance
+ *
+ * @see GenericObjectPool#setMinIdle(int)
+ */
public void setMinIdle(int minIdle) {
this.minIdle = minIdle;
}
Modified:
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolMXBean.java
URL:
http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolMXBean.java?rev=1533373&r1=1533372&r2=1533373&view=diff
==============================================================================
---
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolMXBean.java
(original)
+++
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolMXBean.java
Fri Oct 18 09:50:46 2013
@@ -29,141 +29,175 @@ public interface GenericObjectPoolMXBean
// Getters for basic configuration settings
/**
* See {@link GenericObjectPool#getBlockWhenExhausted()}
+ * @return See {@link GenericObjectPool#getBlockWhenExhausted()}
*/
boolean getBlockWhenExhausted();
/**
* See {@link GenericObjectPool#getLifo()}
+ * @return See {@link GenericObjectPool#getLifo()}
*/
boolean getLifo();
/**
* See {@link GenericObjectPool#getMaxIdle()}
+ * @return See {@link GenericObjectPool#getMaxIdle()}
*/
int getMaxIdle();
/**
* See {@link GenericObjectPool#getMaxTotal()}
+ * @return See {@link GenericObjectPool#getMaxTotal()}
*/
int getMaxTotal();
/**
* See {@link GenericObjectPool#getMaxWaitMillis()}
+ * @return See {@link GenericObjectPool#getMaxWaitMillis()}
*/
long getMaxWaitMillis();
/**
* See {@link GenericObjectPool#getMinEvictableIdleTimeMillis()}
+ * @return See {@link GenericObjectPool#getMinEvictableIdleTimeMillis()}
*/
long getMinEvictableIdleTimeMillis();
/**
* See {@link GenericObjectPool#getMinIdle()}
+ * @return See {@link GenericObjectPool#getMinIdle()}
*/
int getMinIdle();
/**
* See {@link GenericObjectPool#getNumActive()}
+ * @return See {@link GenericObjectPool#getNumActive()}
*/
int getNumActive();
/**
* See {@link GenericObjectPool#getNumIdle()}
+ * @return See {@link GenericObjectPool#getNumIdle()}
*/
int getNumIdle();
/**
* See {@link GenericObjectPool#getNumTestsPerEvictionRun()}
+ * @return See {@link GenericObjectPool#getNumTestsPerEvictionRun()}
*/
int getNumTestsPerEvictionRun();
/**
* See {@link GenericObjectPool#getTestOnBorrow()}
+ * @return See {@link GenericObjectPool#getTestOnBorrow()}
*/
boolean getTestOnBorrow();
/**
* See {@link GenericObjectPool#getTestOnReturn()}
+ * @return See {@link GenericObjectPool#getTestOnReturn()}
*/
boolean getTestOnReturn();
/**
* See {@link GenericObjectPool#getTestWhileIdle()}
+ * @return See {@link GenericObjectPool#getTestWhileIdle()}
*/
boolean getTestWhileIdle();
/**
* See {@link GenericObjectPool#getTimeBetweenEvictionRunsMillis()}
+ * @return See {@link GenericObjectPool#getTimeBetweenEvictionRunsMillis()}
*/
long getTimeBetweenEvictionRunsMillis();
/**
* See {@link GenericObjectPool#isClosed()}
+ * @return See {@link GenericObjectPool#isClosed()}
*/
boolean isClosed();
// Getters for monitoring attributes
/**
* See {@link GenericObjectPool#getBorrowedCount()}
+ * @return See {@link GenericObjectPool#getBorrowedCount()}
*/
long getBorrowedCount();
/**
* See {@link GenericObjectPool#getReturnedCount()}
+ * @return See {@link GenericObjectPool#getReturnedCount()}
*/
long getReturnedCount();
/**
* See {@link GenericObjectPool#getCreatedCount()}
+ * @return See {@link GenericObjectPool#getCreatedCount()}
*/
long getCreatedCount();
/**
* See {@link GenericObjectPool#getDestroyedCount()}
+ * @return See {@link GenericObjectPool#getDestroyedCount()}
*/
long getDestroyedCount();
/**
* See {@link GenericObjectPool#getDestroyedByEvictorCount()}
+ * @return See {@link GenericObjectPool#getDestroyedByEvictorCount()}
*/
long getDestroyedByEvictorCount();
/**
* See {@link GenericObjectPool#getDestroyedByBorrowValidationCount()}
+ * @return See {@link
GenericObjectPool#getDestroyedByBorrowValidationCount()}
*/
long getDestroyedByBorrowValidationCount();
/**
* See {@link GenericObjectPool#getMeanActiveTimeMillis()}
+ * @return See {@link GenericObjectPool#getMeanActiveTimeMillis()}
*/
long getMeanActiveTimeMillis();
/**
* See {@link GenericObjectPool#getMeanIdleTimeMillis()}
+ * @return See {@link GenericObjectPool#getMeanIdleTimeMillis()}
*/
long getMeanIdleTimeMillis();
/**
* See {@link GenericObjectPool#getMeanBorrowWaitTimeMillis()}
+ * @return See {@link GenericObjectPool#getMeanBorrowWaitTimeMillis()}
*/
long getMeanBorrowWaitTimeMillis();
/**
* See {@link GenericObjectPool#getMaxBorrowWaitTimeMillis()}
+ * @return See {@link GenericObjectPool#getMaxBorrowWaitTimeMillis()}
*/
long getMaxBorrowWaitTimeMillis();
/**
* See {@link GenericObjectPool#getCreationStackTrace()}
+ * @return See {@link GenericObjectPool#getCreationStackTrace()}
*/
String getCreationStackTrace();
/**
* See {@link GenericObjectPool#getNumWaiters()}
+ * @return See {@link GenericObjectPool#getNumWaiters()}
*/
int getNumWaiters();
// Getters for abandoned object removal configuration
/**
* See {@link GenericObjectPool#isAbandonedConfig()}
+ * @return See {@link GenericObjectPool#isAbandonedConfig()}
*/
boolean isAbandonedConfig();
/**
* See {@link GenericObjectPool#getLogAbandoned()}
+ * @return See {@link GenericObjectPool#getLogAbandoned()}
*/
boolean getLogAbandoned();
/**
* See {@link GenericObjectPool#getRemoveAbandonedOnBorrow()}
+ * @return See {@link GenericObjectPool#getRemoveAbandonedOnBorrow()}
*/
boolean getRemoveAbandonedOnBorrow();
/**
* See {@link GenericObjectPool#getRemoveAbandonedOnMaintenance()}
+ * @return See {@link GenericObjectPool#getRemoveAbandonedOnMaintenance()}
*/
boolean getRemoveAbandonedOnMaintenance();
/**
* See {@link GenericObjectPool#getRemoveAbandonedTimeout()}
+ * @return See {@link GenericObjectPool#getRemoveAbandonedTimeout()}
*/
int getRemoveAbandonedTimeout();
/**
* See {@link GenericObjectPool#getFactoryType()}
+ * @return See {@link GenericObjectPool#getFactoryType()}
*/
public String getFactoryType();
/**
* See {@link GenericObjectPool#listAllObjects()}
+ * @return See {@link GenericObjectPool#listAllObjects()}
*/
Set<DefaultPooledObjectInfo> listAllObjects();
}
