[Jboss-cvs] JBossAS SVN: r56246 - branches/JBoss_4_0_3_SP1_JBAS_3453/connector/src/main/org/jboss/resource/connectionmanager

[jboss-cvs-commits at lists.jboss.org]

Author: weston.price at jboss.com
Date: 2006-08-25 03:39:29 -0400 (Fri, 25 Aug 2006)
New Revision: 56246

Modified:
   branches/JBoss_4_0_3_SP1_JBAS_3453/connector/src/main/org/jboss/resource/connectionmanager/PoolPurgeSupport.java
Log:
[JBAS-3453] Copyright, comments etc.

Modified: branches/JBoss_4_0_3_SP1_JBAS_3453/connector/src/main/org/jboss/resource/connectionmanager/PoolPurgeSupport.java
===================================================================
--- branches/JBoss_4_0_3_SP1_JBAS_3453/connector/src/main/org/jboss/resource/connectionmanager/PoolPurgeSupport.java	2006-08-25 07:37:32 UTC (rev 56245)
+++ branches/JBoss_4_0_3_SP1_JBAS_3453/connector/src/main/org/jboss/resource/connectionmanager/PoolPurgeSupport.java	2006-08-25 07:39:29 UTC (rev 56246)
@@ -1,3 +1,10 @@
+/*
+ * JBoss, the OpenSource J2EE webOS
+ *
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
+ */
+
 package org.jboss.resource.connectionmanager;
 
 /**
@@ -9,9 +16,24 @@
 public interface PoolPurgeSupport
 {
    
+   /**
+    * Get the number of connections that have been purged from the pool
+    * 
+    * @return the number of connections that have been purged from the pool
+    */
    public int getConnectionPurgeCount();
    
+   /**
+    * The number of times the pool has been purged.
+    * 
+    * @return the number of times the pool has been purged.
+    */
    public int getPoolPurgeCount();
    
+   /**
+    * The number of stale connections that have been detected.
+    * 
+    * @return the number of stale connections that have been detected
+    */
    public int getStaleConnectionCount();
 }