You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by ak...@apache.org on 2008/08/22 02:08:52 UTC

svn commit: r687911 - /directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/SearchTimeLimitingMonitor.java

Author: akarasulu
Date: Thu Aug 21 17:08:51 2008
New Revision: 687911

URL: http://svn.apache.org/viewvc?rev=687911&view=rev
Log:
adding javadocs

Modified:
    directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/SearchTimeLimitingMonitor.java

Modified: directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/SearchTimeLimitingMonitor.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/SearchTimeLimitingMonitor.java?rev=687911&r1=687910&r2=687911&view=diff
==============================================================================
--- directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/SearchTimeLimitingMonitor.java (original)
+++ directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/SearchTimeLimitingMonitor.java Thu Aug 21 17:08:51 2008
@@ -42,6 +42,13 @@
     private Exception cause;
     
     
+    /**
+     * Creates a new instance of SearchTimeLimitingMonitor.
+     *
+     * @param timeToLive the time before changing state to closed.
+     * @param unit the time units for the timeToLive parameter
+     * @see {@link TimeUnit}
+     */
     public SearchTimeLimitingMonitor( long timeToLive, TimeUnit unit )
     {
         switch ( unit )
@@ -61,6 +68,10 @@
     }
 
     
+    /*
+     * (non-Javadoc)
+     * @see org.apache.directory.server.core.cursor.ClosureMonitor#checkNotClosed()
+     */
     public void checkNotClosed() throws Exception
     {
         if ( System.currentTimeMillis() > startTime + millisToLive )
@@ -85,6 +96,10 @@
     }
 
     
+    /*
+     * (non-Javadoc)
+     * @see org.apache.directory.server.core.cursor.ClosureMonitor#close()
+     */
     public void close()
     {
         if ( ! closed )
@@ -98,6 +113,10 @@
     }
 
     
+    /*
+     * (non-Javadoc)
+     * @see org.apache.directory.server.core.cursor.ClosureMonitor#close(java.lang.String)
+     */
     public void close( String cause )
     {
         if ( ! closed )
@@ -110,7 +129,11 @@
         }
     }
 
-    
+
+    /*
+     * (non-Javadoc)
+     * @see org.apache.directory.server.core.cursor.ClosureMonitor#close(java.lang.Exception)
+     */
     public void close( Exception cause )
     {
         if ( ! closed )
@@ -124,12 +147,20 @@
     }
 
     
+    /*
+     * (non-Javadoc)
+     * @see org.apache.directory.server.core.cursor.ClosureMonitor#getCause()
+     */
     public Exception getCause()
     {
         return cause;
     }
 
     
+    /*
+     * (non-Javadoc)
+     * @see org.apache.directory.server.core.cursor.ClosureMonitor#isClosed()
+     */
     public boolean isClosed()
     {
         if ( System.currentTimeMillis() > startTime + millisToLive )