[qdox-scm] [1322] trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker: Add javadoc and format code

Sat, 10 Sep 2011 10:04:41 -0700

Title: [1322] trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker: Add javadoc and format code

Diff

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/DirectoryScanner.java (1321 => 1322)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/DirectoryScanner.java	2011-09-10 16:31:09 UTC (rev 1321)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/DirectoryScanner.java	2011-09-10 17:04:34 UTC (rev 1322)
@@ -25,46 +25,82 @@
 import java.util.LinkedList;
 import java.util.List;
 
-public class DirectoryScanner {
-    
+/**
+ * A directory scanner, which can scan files based on optional filters.
+ */
+public class DirectoryScanner
+{
+
     private File file;
+
     private Collection<Filter> filters = new HashSet<Filter>();
 
-    public DirectoryScanner(File file) {
+    /**
+     * 
+     * @param file the directory (or file) to scan
+     */
+    public DirectoryScanner( File file )
+    {
         this.file = file;
     }
 
-    public List<File> scan() {
+    /**
+     * Add a filter to this scanner.
+     * 
+     * @param filter the filter
+     */
+    public void addFilter( Filter filter )
+    {
+        this.filters.add( filter );
+    }
+
+    /**
+     * 
+     * @return a list of files matching the filters, never <code>null</code>
+     */
+    public List<File> scan()
+    {
         final List<File> result = new LinkedList<File>();
-        walk( new FileVisitor() {
-            public void visitFile(File file) {
-                result.add(file);
+        walk( new FileVisitor()
+        {
+            public void visitFile( File file )
+            {
+                result.add( file );
             }
-        }, this.file);
+        }, this.file );
         return result;
     }
 
-    private void walk(FileVisitor visitor, File current) {
-        if (current.isDirectory()) {
+    /**
+     * Scans the directory. Every file not filtered out by a filter fill be passed to the {@code fileVisitor}
+     * 
+     * @param fileVisitor handler for matching files.
+     */
+    public void scan( FileVisitor fileVisitor )
+    {
+        walk( fileVisitor, this.file );
+    }
+
+    private void walk( FileVisitor visitor, File current )
+    {
+        if ( current.isDirectory() )
+        {
             File[] currentFiles = current.listFiles();
-            for (int i = 0; i < currentFiles.length; i++) {
-                walk(visitor, currentFiles[i]);
+            for ( int i = 0; i < currentFiles.length; i++ )
+            {
+                walk( visitor, currentFiles[i] );
             }
-        } else {
-            for (Filter filter : this.filters) {
-                if (!filter.filter(current)) {
+        }
+        else
+        {
+            for ( Filter filter : this.filters )
+            {
+                if ( !filter.filter( current ) )
+                {
                     return;
                 }
             }
-            visitor.visitFile(current);
+            visitor.visitFile( current );
         }
     }
-
-    public void addFilter(Filter filter) {
-        this.filters.add(filter);
-    }
-
-    public void scan(FileVisitor fileVisitor) {
-        walk(fileVisitor, this.file);
-    }
 }

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/FileVisitor.java (1321 => 1322)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/FileVisitor.java	2011-09-10 16:31:09 UTC (rev 1321)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/FileVisitor.java	2011-09-10 17:04:34 UTC (rev 1322)
@@ -21,8 +21,16 @@
 
 import java.io.File;
 
-public interface FileVisitor {
+/**
+ * A File visitor 
+ */
+public interface FileVisitor
+{
 
-    void visitFile(File file);
+    /**
+     * 
+     * @param file the file to visit
+     */
+    void visitFile( File file );
 
 }

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/Filter.java (1321 => 1322)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/Filter.java	2011-09-10 16:31:09 UTC (rev 1321)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/Filter.java	2011-09-10 17:04:34 UTC (rev 1322)
@@ -21,8 +21,14 @@
 
 import java.io.File;
 
-public interface Filter {
+public interface Filter
+{
 
-    boolean filter(File file);
+    /**
+     * 
+     * @param file the file to filter
+     * @return returns <code>true</code> if the file matches the filter _expression_, otherwise <code>false</code>
+     */
+    boolean filter( File file );
 
 }

Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/SuffixFilter.java (1321 => 1322)

--- trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/SuffixFilter.java	2011-09-10 16:31:09 UTC (rev 1321)
+++ trunk/qdox/src/main/java/com/thoughtworks/qdox/directorywalker/SuffixFilter.java	2011-09-10 17:04:34 UTC (rev 1322)
@@ -21,14 +21,31 @@
 
 import java.io.File;
 
-public class SuffixFilter implements Filter {
+/**
+ * 
+ * A file filter based on its suffix
+ *
+ */
+public class SuffixFilter
+    implements Filter
+{
     private String suffixFilter;
 
-    public SuffixFilter(String suffixFilter) {
+    /**
+     * 
+     * @param suffixFilter the suffix which will be matched for every file.
+     */
+    public SuffixFilter( String suffixFilter )
+    {
         this.suffixFilter = suffixFilter;
     }
 
-    public boolean filter(File file) {
-        return file.getName().endsWith(this.suffixFilter);
+    /**
+     * @param file the file to filter
+     * @return <code>true</code> if the file ends with the specified suffix, otherwise <code>false</code>
+     */
+    public boolean filter( File file )
+    {
+        return file.getName().endsWith( this.suffixFilter );
     }
 }

To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email

Reply via email to