svn commit: r201755 - in /jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find: FindListener.java FindingFilter.java

[sc...@apache.org]

Author: scolebourne
Date: Sat Jun 25 08:23:41 2005
New Revision: 201755

URL: http://svn.apache.org/viewcvs?rev=201755&view=rev
Log:
Add javadoc

Modified:
    jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindListener.java
    jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindingFilter.java

Modified: jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindListener.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindListener.java?rev=201755&r1=201754&r2=201755&view=diff
==============================================================================
--- jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindListener.java (original)
+++ jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindListener.java Sat Jun 25 08:23:41 2005
@@ -1,5 +1,5 @@
 /*
- * Copyright 2001-2004 The Apache Software Foundation.
+ * Copyright 2001-2005 The Apache Software Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,24 +15,34 @@
  */
 package org.apache.commons.io.find;
 
+/**
+ * A listener interface that is called during the finder process.
+ * 
+ * @author Henri Yandell
+ * @version $Id$
+ * @since 1.1
+ */
 public interface FindListener {
 
     /**
-     * A directory has begun to be looked at by a Finder.
+     * Listener event called when a directory is about to be examined.
+     * 
+     * @param findEvent  the event object
      */
     public void directoryStarted(FindEvent findEvent);
 
     /**
-     * A directory has been finished. The FindEvent will 
-     * contain an array of the filenames found.
+     * Listener event called when a directory has been fully processed.
+     * 
+     * @param findEvent  the event object
      */
     public void directoryFinished(FindEvent findEvent);
 
     /**
-     * A file has been found. The FindEvent will contain the 
-     * filename found.
+     * Listener event called when a file is found.
+     * 
+     * @param findEvent  the event object
      */
     public void fileFound(FindEvent findEvent);
-//    public void entryFound(FindEvent findEvent);
 
 }

Modified: jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindingFilter.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindingFilter.java?rev=201755&r1=201754&r2=201755&view=diff
==============================================================================
--- jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindingFilter.java (original)
+++ jakarta/commons/proper/io/branches/finder-reminder/java/org/apache/commons/io/find/FindingFilter.java Sat Jun 25 08:23:41 2005
@@ -28,16 +28,30 @@
 import org.apache.commons.io.FilenameUtils;
 
 /**
+ * Filters that can check whether to include a file in the response or not.
+ * <p>
  * This is where most of the find functionality occurs. Nearly every option 
  * to find is mapped to a FileFilter, which are then chained together inside 
- * this class. 
+ * this class.
+ * 
+ * @author Henri Yandell
+ * @version $Id$
+ * @since 1.1
  */
 public class FindingFilter implements FileFilter {
 
+    /** The options to use. */
     private Map options;
+    /** The filters to use. */
     private List filters = new LinkedList();
+    /** The daystart flag. */
     private boolean daystart;
 
+    /**
+     * Constructor.
+     * 
+     * @param options  the options to use
+     */
     public FindingFilter(Map options) {
         this.options = options;
         Collection entries = options.entrySet();
@@ -212,7 +226,7 @@
             this.argument = new Boolean(argument.toString()).booleanValue();
         }
         public boolean accept(File file) {
-            return FindingFilter.invert( this.invert,  (!file.isDirectory() && file.length() == 0) == this.argument );
+            return FindingFilter.invert( this.invert, (!file.isDirectory() && file.length() == 0) == this.argument );
         }
     }
 



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org