You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ma...@apache.org on 2012/04/25 11:17:50 UTC
svn commit: r1330167 -
/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
Author: markt
Date: Wed Apr 25 09:17:49 2012
New Revision: 1330167
URL: http://svn.apache.org/viewvc?rev=1330167&view=rev
Log:
More Javadoc
Modified:
commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java?rev=1330167&r1=1330166&r2=1330167&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java (original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java Wed Apr 25 09:17:49 2012
@@ -259,66 +259,157 @@ public abstract class BaseObjectPoolConf
this.numTestsPerEvictionRun = numTestsPerEvictionRun;
}
+ /**
+ * Get the value for the {@code testOnBorrow} configuration attribute for
+ * pools created with this configuration instance.
+ * @see GenericObjectPool#getTestOnBorrow()
+ * @see GenericKeyedObjectPool#getTestOnBorrow()
+ */
public boolean getTestOnBorrow() {
return testOnBorrow;
}
+ /**
+ * Set the value for the {@code testOnBorrow} configuration attribute for
+ * pools created with this configuration instance.
+ * @see GenericObjectPool#getTestOnBorrow()
+ * @see GenericKeyedObjectPool#getTestOnBorrow()
+ */
public void setTestOnBorrow(boolean testOnBorrow) {
this.testOnBorrow = testOnBorrow;
}
+ /**
+ * Get the value for the {@code testOnReturn} configuration attribute for
+ * pools created with this configuration instance.
+ * @see GenericObjectPool#getTestOnReturn()
+ * @see GenericKeyedObjectPool#getTestOnReturn()
+ */
public boolean getTestOnReturn() {
return testOnReturn;
}
+ /**
+ * Set the value for the {@code testOnReturn} configuration attribute for
+ * pools created with this configuration instance.
+ * @see GenericObjectPool#getTestOnReturn()
+ * @see GenericKeyedObjectPool#getTestOnReturn()
+ */
public void setTestOnReturn(boolean testOnReturn) {
this.testOnReturn = testOnReturn;
}
+ /**
+ * Get the value for the {@code testWhileIdle} configuration attribute for
+ * pools created with this configuration instance.
+ * @see GenericObjectPool#getTestWhileIdle()
+ * @see GenericKeyedObjectPool#getTestWhileIdle()
+ */
public boolean getTestWhileIdle() {
return testWhileIdle;
}
+ /**
+ * Set the value for the {@code testWhileIdle} configuration attribute for
+ * pools created with this configuration instance.
+ * @see GenericObjectPool#getTestWhileIdle()
+ * @see GenericKeyedObjectPool#getTestWhileIdle()
+ */
public void setTestWhileIdle(boolean testWhileIdle) {
this.testWhileIdle = testWhileIdle;
}
+ /**
+ * Get the value for the {@code timeBetweenEvictionRunsMillis} configuration
+ * attribute for pools created with this configuration instance.
+ * @see GenericObjectPool#getTimeBetweenEvictionRunsMillis()
+ * @see GenericKeyedObjectPool#getTimeBetweenEvictionRunsMillis()
+ */
public long getTimeBetweenEvictionRunsMillis() {
return timeBetweenEvictionRunsMillis;
}
- public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis) {
+ /**
+ * Set the value for the {@code timeBetweenEvictionRunsMillis} configuration
+ * attribute for pools created with this configuration instance.
+ * @see GenericObjectPool#getTimeBetweenEvictionRunsMillis()
+ * @see GenericKeyedObjectPool#getTimeBetweenEvictionRunsMillis()
+ */
+ public void setTimeBetweenEvictionRunsMillis(
+ long timeBetweenEvictionRunsMillis) {
this.timeBetweenEvictionRunsMillis = timeBetweenEvictionRunsMillis;
}
+ /**
+ * Get the value for the {@code evictionPolicyClassName} configuration
+ * attribute for pools created with this configuration instance.
+ * @see GenericObjectPool#getEvictionPolicyClassName()
+ * @see GenericKeyedObjectPool#getEvictionPolicyClassName()
+ */
public String getEvictionPolicyClassName() {
return evictionPolicyClassName;
}
+ /**
+ * Set the value for the {@code evictionPolicyClassName} configuration
+ * attribute for pools created with this configuration instance.
+ * @see GenericObjectPool#getEvictionPolicyClassName()
+ * @see GenericKeyedObjectPool#getEvictionPolicyClassName()
+ */
public void setEvictionPolicyClassName(String evictionPolicyClassName) {
this.evictionPolicyClassName = evictionPolicyClassName;
}
+ /**
+ * Get the value for the {@code blockWhenExhausted} configuration attribute
+ * for pools created with this configuration instance.
+ * @see GenericObjectPool#getBlockWhenExhausted()
+ * @see GenericKeyedObjectPool#getBlockWhenExhausted()
+ */
public boolean getBlockWhenExhausted() {
return blockWhenExhausted;
}
+ /**
+ * Set the value for the {@code blockWhenExhausted} configuration attribute
+ * for pools created with this configuration instance.
+ * @see GenericObjectPool#getBlockWhenExhausted()
+ * @see GenericKeyedObjectPool#getBlockWhenExhausted()
+ */
public void setBlockWhenExhausted(boolean blockWhenExhausted) {
this.blockWhenExhausted = blockWhenExhausted;
}
+ /**
+ * Gets the value of the flag that determines if JMX will be enabled for
+ * pools created with this configuration instance.
+ */
public boolean isJmxEnabled() {
return jmxEnabled;
}
+ /**
+ * Sets the value of the flag that determines if JMX will be enabled for
+ * pools created with this configuration instance.
+ */
public void setJmxEnabled(boolean jmxEnabled) {
this.jmxEnabled = jmxEnabled;
}
+ /**
+ * Gets the value of the JMX name prefix that will be used as part of the
+ * name assigned to JMX enabled pools created with this configuration
+ * instance.
+ */
public String getJmxNamePrefix() {
return jmxNamePrefix;
}
+ /**
+ * Sets the value of the JMX name prefix that will be used as part of the
+ * name assigned to JMX enabled pools created with this configuration
+ * instance.
+ */
public void setJmxNamePrefix(String jmxNamePrefix) {
this.jmxNamePrefix = jmxNamePrefix;
}