commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r1532283 - in /commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl: AbandonedConfig.java BaseGenericObjectPool.java BaseObjectPoolConfig.java
Date Tue, 15 Oct 2013 10:51:19 GMT
Author: markt
Date: Tue Oct 15 10:51:19 2013
New Revision: 1532283

URL: http://svn.apache.org/r1532283
Log:
Fix some more checkstyle warnings

Modified:
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
    commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
    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/AbandonedConfig.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java?rev=1532283&r1=1532282&r2=1532283&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
(original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
Tue Oct 15 10:51:19 2013
@@ -208,6 +208,8 @@ public class AbandonedConfig {
      * If the pool implements {@link UsageTracking}, should the pool record a
      * stack trace every time a method is called on a pooled object and retain
      * the most recent stack trace to aid debugging of abandoned objects?
+     *
+     * @return <code>true</code> if usage tracking is enabled
      */
     public boolean getUseUsageTracking() {
         return useUsageTracking;
@@ -218,6 +220,10 @@ public class AbandonedConfig {
      * should record a stack trace every time a method is called on a pooled
      * object and retain the most recent stack trace to aid debugging of
      * abandoned objects.
+     *
+     * @param   useUsageTracking    A value of <code>true</code> will enable
+     *                              the recording of a stack trace on every use
+     *                              of a pooled object
      */
     public void setUseUsageTracking(boolean useUsageTracking) {
         this.useUsageTracking = useUsageTracking;

Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java?rev=1532283&r1=1532282&r2=1532283&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
(original)
+++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
Tue Oct 15 10:51:19 2013
@@ -764,6 +764,8 @@ public abstract class BaseGenericObjectP
     /**
      * The listener used (if any) to receive notifications of exceptions
      * unavoidably swallowed by the pool.
+     *
+     * @return The listener or <code>null</code> for no listener
      */
     public SwallowedExceptionListener getSwallowedExceptionListener() {
         return swallowedExceptionListener;

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=1532283&r1=1532282&r2=1532283&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
Tue Oct 15 10:51:19 2013
@@ -163,6 +163,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code lifo} configuration attribute for pools
      * created with this configuration instance.
+     *
+     * @return  The current setting of {@code lifo} for this configuration
+     *          instance
+     *
      * @see GenericObjectPool#getLifo()
      * @see GenericKeyedObjectPool#getLifo()
      */
@@ -183,6 +187,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code maxWait} configuration attribute for pools
      * created with this configuration instance.
+     *
+     * @return  The current setting of {@code maxWait} for this
+     *          configuration instance
+     *
      * @see GenericObjectPool#getMaxWaitMillis()
      * @see GenericKeyedObjectPool#getMaxWaitMillis()
      */
@@ -203,6 +211,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code minEvictableIdleTimeMillis} configuration
      * attribute for pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code minEvictableIdleTimeMillis} for
+     *          this configuration instance
+     *
      * @see GenericObjectPool#getMinEvictableIdleTimeMillis()
      * @see GenericKeyedObjectPool#getMinEvictableIdleTimeMillis()
      */
@@ -224,6 +236,10 @@ public abstract class BaseObjectPoolConf
      * Get the value for the {@code softMinEvictableIdleTimeMillis}
      * configuration attribute for pools created with this configuration
      * instance.
+     *
+     * @return  The current setting of {@code softMinEvictableIdleTimeMillis}
+     *          for this configuration instance
+     *
      * @see GenericObjectPool#getSoftMinEvictableIdleTimeMillis()
      * @see GenericKeyedObjectPool#getSoftMinEvictableIdleTimeMillis()
      */
@@ -246,6 +262,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code numTestsPerEvictionRun} configuration
      * attribute for pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code numTestsPerEvictionRun} for this
+     *          configuration instance
+     *
      * @see GenericObjectPool#getNumTestsPerEvictionRun()
      * @see GenericKeyedObjectPool#getNumTestsPerEvictionRun()
      */
@@ -266,6 +286,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code testOnBorrow} configuration attribute for
      * pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code testOnBorrow} for this
+     *          configuration instance
+     *
      * @see GenericObjectPool#getTestOnBorrow()
      * @see GenericKeyedObjectPool#getTestOnBorrow()
      */
@@ -286,6 +310,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code testOnReturn} configuration attribute for
      * pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code testOnReturn} for this
+     *          configuration instance
+     *
      * @see GenericObjectPool#getTestOnReturn()
      * @see GenericKeyedObjectPool#getTestOnReturn()
      */
@@ -306,6 +334,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code testWhileIdle} configuration attribute for
      * pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code testWhileIdle} for this
+     *          configuration instance
+     *
      * @see GenericObjectPool#getTestWhileIdle()
      * @see GenericKeyedObjectPool#getTestWhileIdle()
      */
@@ -326,6 +358,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code timeBetweenEvictionRunsMillis} configuration
      * attribute for pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code timeBetweenEvictionRunsMillis} for
+     *          this configuration instance
+     *
      * @see GenericObjectPool#getTimeBetweenEvictionRunsMillis()
      * @see GenericKeyedObjectPool#getTimeBetweenEvictionRunsMillis()
      */
@@ -347,6 +383,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code evictionPolicyClassName} configuration
      * attribute for pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code evictionPolicyClassName} for this
+     *          configuration instance
+     *
      * @see GenericObjectPool#getEvictionPolicyClassName()
      * @see GenericKeyedObjectPool#getEvictionPolicyClassName()
      */
@@ -367,6 +407,10 @@ public abstract class BaseObjectPoolConf
     /**
      * Get the value for the {@code blockWhenExhausted} configuration attribute
      * for pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code blockWhenExhausted} for this
+     *          configuration instance
+     *
      * @see GenericObjectPool#getBlockWhenExhausted()
      * @see GenericKeyedObjectPool#getBlockWhenExhausted()
      */
@@ -387,6 +431,9 @@ public abstract class BaseObjectPoolConf
     /**
      * Gets the value of the flag that determines if JMX will be enabled for
      * pools created with this configuration instance.
+     *
+     * @return  The current setting of {@code jmxEnabled} for this configuration
+     *          instance
      */
     public boolean getJmxEnabled() {
         return jmxEnabled;
@@ -404,6 +451,9 @@ public abstract class BaseObjectPoolConf
      * 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.
+     *
+     * @return  The current setting of {@code jmxNamePrefix} for this
+     *          configuration instance
      */
     public String getJmxNamePrefix() {
         return jmxNamePrefix;



Mime
View raw message