(no commit message)

[utils] / support / general / src / main / java / org / wamblee / io / DirectoryMonitor.java

diff --git a/support/general/src/main/java/org/wamblee/io/DirectoryMonitor.java b/support/general/src/main/java/org/wamblee/io/DirectoryMonitor.java
index 301349803044a9dc09335f235b51da53a70f8946..13181975068e0233f122411942d49e1ab319fab8 100644 (file)
--- a/support/general/src/main/java/org/wamblee/io/DirectoryMonitor.java
+++ b/support/general/src/main/java/org/wamblee/io/DirectoryMonitor.java
@@ -1,18 +1,18 @@
 /*
- * Copyright 2006 the original author or authors.
- *
+ * Copyright 2005-2010 the original author or authors.
+ * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- *
+ * 
  *      http://www.apache.org/licenses/LICENSE-2.0
- *
+ * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */
+ */ 
 package org.wamblee.io;
 
 import org.apache.commons.logging.Log;
@@ -29,6 +29,8 @@ import java.util.Set;
 
 /**
  * Monitors a directory for changes.
+ * The currernt implementation only checks files not directories and does not check for 
+ * modifications in subdirectories. 
  * 
  * @author Erik Brakkee
  */
@@ -110,11 +112,26 @@ public class DirectoryMonitor {
         contents = newContents;
     }
 
+    /**
+     * Listener interface to be provided by users of the directory monitor to get notified of
+     * changes. 
+     * 
+     * @author Erik Brakkee
+     */
     public static interface Listener {
+        /**
+         * @param aFile File that has changed. 
+         */
         void fileChanged(File aFile);
 
+        /**
+         * @param aFile File that was created. 
+         */
         void fileCreated(File aFile);
 
+        /**
+         * @param aFile File that was deleted.
+         */
         void fileDeleted(File aFile);
     }
 }