(no commit message)
authorErik Brakkee <erik@brakkee.org>
Mon, 5 Jul 2010 07:50:57 +0000 (07:50 +0000)
committerErik Brakkee <erik@brakkee.org>
Mon, 5 Jul 2010 07:50:57 +0000 (07:50 +0000)
support/general/src/main/java/org/wamblee/io/DirectoryMonitor.java
support/general/src/main/java/org/wamblee/io/package-info.java [new file with mode: 0644]
support/general/src/main/java/org/wamblee/io/package.html [deleted file]

index a4ad6d87f4a0bbf8f57c9f2a87318db57797558e..13181975068e0233f122411942d49e1ab319fab8 100644 (file)
@@ -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);
     }
 }
diff --git a/support/general/src/main/java/org/wamblee/io/package-info.java b/support/general/src/main/java/org/wamblee/io/package-info.java
new file mode 100644 (file)
index 0000000..fd7ba73
--- /dev/null
@@ -0,0 +1,27 @@
+/*
+ * 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.
+ */ 
+/**
+ * This package provides several support utilities for IO related functionality.
+ * The main classes are: 
+ * <ul>
+ *   <li> {@link InputResource}: An abstraction of an input stream with several possible 
+ *        implementations. 
+ *   </li>
+ *   <li> {@link DirectoryMonitor}: A utility for monitoring a directory for changes. 
+ *   </li>
+ * </ul>
+ */
+package org.wamblee.io;
diff --git a/support/general/src/main/java/org/wamblee/io/package.html b/support/general/src/main/java/org/wamblee/io/package.html
deleted file mode 100644 (file)
index 2023c07..0000000
+++ /dev/null
@@ -1,15 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-    wamblee.org
-</head>
-<body bgcolor="white">
-
-This package provides several support utilities for IO related functionality.
-
-<!-- Put @see and @since tags down here. -->
-
-@since -
-
-</body>
-</html>