svn commit: r1517916 - /commons/proper/jci/trunk/fam/src/main/java/org/apache/commons/jci/monitor/FilesystemAlterationMonitor.java

[se...@apache.org]

Author: sebb
Date: Tue Aug 27 18:49:16 2013
New Revision: 1517916

URL: http://svn.apache.org/r1517916
Log:
Javadoc

Modified:
    commons/proper/jci/trunk/fam/src/main/java/org/apache/commons/jci/monitor/FilesystemAlterationMonitor.java

Modified: commons/proper/jci/trunk/fam/src/main/java/org/apache/commons/jci/monitor/FilesystemAlterationMonitor.java
URL: http://svn.apache.org/viewvc/commons/proper/jci/trunk/fam/src/main/java/org/apache/commons/jci/monitor/FilesystemAlterationMonitor.java?rev=1517916&r1=1517915&r2=1517916&view=diff
==============================================================================
--- commons/proper/jci/trunk/fam/src/main/java/org/apache/commons/jci/monitor/FilesystemAlterationMonitor.java (original)
+++ commons/proper/jci/trunk/fam/src/main/java/org/apache/commons/jci/monitor/FilesystemAlterationMonitor.java Tue Aug 27 18:49:16 2013
@@ -36,7 +36,9 @@ public final class FilesystemAlterationM
     private final Log log = LogFactory.getLog(FilesystemAlterationMonitor.class);
 
     private final Object observersLock = new Object();
-    private Map<File, FilesystemAlterationObserver> observers = Collections.unmodifiableMap(new HashMap<File, FilesystemAlterationObserver>());    
+    private Map<File, FilesystemAlterationObserver> observers = Collections.unmodifiableMap(new HashMap<File, FilesystemAlterationObserver>());
+    
+    /** delay between calls to {@link FilesystemAlterationObserver#checkAndNotify()}, default 3000 ms */
     private long delay = 3000;
     private Thread thread = null;
 
@@ -64,6 +66,11 @@ public final class FilesystemAlterationM
     }
 
 
+    /**
+     * Set the delay between calls to the observers.
+     *  
+     * @param pDelay the delay in milliseconds (default if not set 3000 ms)
+     */
     public void setInterval( final long pDelay ) {
         delay = pDelay;
     }