Javadoc

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk@140389 13f79535-47bb-0310-9956-ffa450edef68

Author: Stephen Colebourne

src/java/org/apache/commons/io/filefilter/AndFileFilter.java

@@ -1,7 +1,7 @@
 /* ====================================================================
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2003 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -59,7 +59,7 @@
  * This filter produces a logical AND of the two filters specified.
  *
  * @since Commons IO 1.0
- * @version $Revision: 1.4 $ $Date: 2003/07/27 17:11:38 $
+ * @version $Revision: 1.5 $ $Date: 2003/09/20 19:52:38 $
  * 
  * @author Stephen Colebourne
  */
@@ -73,8 +73,9 @@ public class AndFileFilter extends AbstractFileFilter {
     /**
      * Constructs a new file filter that ANDs the result of two other filters.
      * 
-     * @param filter1  the first filter
-     * @param filter2  the second filter
+     * @param filter1  the first filter, must not be null
+     * @param filter2  the second filter, must not be null
+     * @throws IllegalArgumentException if either filter is null
      */
     public AndFileFilter(IOFileFilter filter1, IOFileFilter filter2) {
         if (filter1 == null || filter2 == null) {

src/java/org/apache/commons/io/filefilter/FalseFileFilter.java

@@ -1,7 +1,7 @@
 /* ====================================================================
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2003 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -59,7 +59,7 @@
  * A file filter that always returns false.
  * 
  * @since Commons IO 1.0
- * @version $Revision: 1.2 $ $Date: 2003/07/27 17:11:38 $
+ * @version $Revision: 1.3 $ $Date: 2003/09/20 19:52:38 $
  * 
  * @author Henri Yandell
  * @author Stephen Colebourne
@@ -76,7 +76,7 @@ protected FalseFileFilter() {
     }
 
     /**
-     * Return false.
+     * Returns false.
      * 
      * @param file  the file to check
      * @return false
@@ -86,7 +86,7 @@ public boolean accept(File file) {
     }
 
     /**
-     * Return false.
+     * Returns false.
      * 
      * @param dir  the directory to check
      * @param name  the filename

src/java/org/apache/commons/io/filefilter/FileFilterUtils.java

@@ -53,11 +53,14 @@
  */
 package org.apache.commons.io.filefilter;
 
+import java.io.FileFilter;
+import java.io.FilenameFilter;
+
 /**
  * Useful utilities for working with file filters.
  * 
  * @since Commons IO 1.0
- * @version $Revision: 1.3 $ $Date: 2003/07/27 17:11:38 $
+ * @version $Revision: 1.4 $ $Date: 2003/09/20 19:52:38 $
  * 
  * @author Henri Yandell
  * @author Stephen Colebourne
@@ -67,7 +70,7 @@ public class FileFilterUtils {
     /**
      * FileFilterUtils is not normally instantiated.
      */
-    private FileFilterUtils() {
+    public FileFilterUtils() {
     }
 
     //-----------------------------------------------------------------------
@@ -100,6 +103,7 @@ public static IOFileFilter directoryFileFilter() {
         return DirectoryFileFilter.INSTANCE;
     }
 
+    //-----------------------------------------------------------------------
     /**
      * Returns a filter that ANDs the two specified filters.
      * 
@@ -132,6 +136,7 @@ public static IOFileFilter notFileFilter(IOFileFilter filter) {
         return new NotFileFilter(filter);
     }
 
+    //-----------------------------------------------------------------------
     /**
      * Returns a filter that always returns true.
      * 
@@ -150,4 +155,27 @@ public static IOFileFilter falseFileFilter() {
         return FalseFileFilter.INSTANCE;
     }
 
+    //-----------------------------------------------------------------------
+    /**
+     * Returns an <code>IOFileFilter</code> that wraps the
+     * <code>FileFilter</code> instance.
+     * 
+     * @param filter  the filter to be wrapped
+     * @return a new filter that implements IOFileFilter
+     */
+    public static IOFileFilter asFileFilter(FileFilter filter) {
+        return new DelegateFileFilter(filter);
+    }
+
+    /**
+     * Returns an <code>IOFileFilter</code> that wraps the
+     * <code>FilenameFilter</code> instance.
+     * 
+     * @param filter  the filter to be wrapped
+     * @return a new filter that implements IOFileFilter
+     */
+    public static IOFileFilter asFileFilter(FilenameFilter filter) {
+        return new DelegateFileFilter(filter);
+    }
+
 }

src/java/org/apache/commons/io/filefilter/NotFileFilter.java

@@ -1,7 +1,7 @@
 /* ====================================================================
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2003 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -59,7 +59,7 @@
  * This filter produces a logical NOT of the filters specified.
  *
  * @since Commons IO 1.0
- * @version $Revision: 1.2 $ $Date: 2003/07/27 17:11:38 $
+ * @version $Revision: 1.3 $ $Date: 2003/09/20 19:52:38 $
  * 
  * @author Stephen Colebourne
  */
@@ -71,7 +71,8 @@ public class NotFileFilter extends AbstractFileFilter {
     /**
      * Constructs a new file filter that NOTs the result of another filters.
      * 
-     * @param filter  the filter
+     * @param filter  the filter, must not be null
+     * @throws IllegalArgumentException if the filter is null
      */
     public NotFileFilter(IOFileFilter filter) {
         if (filter == null) {

src/java/org/apache/commons/io/filefilter/OrFileFilter.java

@@ -1,7 +1,7 @@
 /* ====================================================================
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2003 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -59,7 +59,7 @@
  * This filter produces a logical OR of the two filters specified.
  *
  * @since Commons IO 1.0
- * @version $Revision: 1.4 $ $Date: 2003/07/27 17:11:38 $
+ * @version $Revision: 1.5 $ $Date: 2003/09/20 19:52:38 $
  * 
  * @author Stephen Colebourne
  */
@@ -73,8 +73,9 @@ public class OrFileFilter extends AbstractFileFilter {
     /**
      * Constructs a new file filter that ORs the result of two other filters.
      * 
-     * @param filter1  the first filter
-     * @param filter2  the second filter
+     * @param filter1  the first filter, must not be null
+     * @param filter2  the second filter, must not be null
+     * @throws IllegalArgumentException if either filter is null
      */
     public OrFileFilter(IOFileFilter filter1, IOFileFilter filter2) {
         if (filter1 == null || filter2 == null) {

src/java/org/apache/commons/io/filefilter/PrefixFileFilter.java

@@ -57,21 +57,21 @@
 import java.util.List;
 
 /**
- * This filters filenames for a certain prefix.
+ * Filters filenames for a certain prefix.
  * <p>
  * For example, to print all files and directories in the 
- * current directory whose name starts with <code>foo</code>:
+ * current directory whose name starts with <code>Test</code>:
  *
  * <pre>
  * File dir = new File(".");
- * String[] files = dir.list( new PrefixFileFilter("foo"));
+ * String[] files = dir.list( new PrefixFileFilter("Test") );
  * for ( int i = 0; i &lt; files.length; i++ ) {
  *     System.out.println(files[i]);
  * }
  * </pre>
  *
  * @since Commons IO 1.0
- * @version $Revision: 1.3 $ $Date: 2003/07/27 17:11:38 $
+ * @version $Revision: 1.4 $ $Date: 2003/09/20 19:52:38 $
  * 
  * @author Henri Yandell
  * @author Stephen Colebourne
@@ -81,13 +81,14 @@
  */
 public class PrefixFileFilter extends AbstractFileFilter {
 
-    /** The filename prefix to search for */
+    /** The filename prefixes to search for */
     private String[] prefixes;
 
     /**
      * Constructs a new Prefix file filter for a single prefix.
      * 
-     * @param prefix  the prefix to allow, null means none
+     * @param prefix  the prefix to allow, must not be null
+     * @throws IllegalArgumentException if the prefix is null
      */
     public PrefixFileFilter(final String prefix) {
         if (prefixes == null) {
@@ -97,12 +98,13 @@ public PrefixFileFilter(final String prefix) {
     }
 
     /**
-     * Constructs a new Prefix file filter for an array of prefixes.
+     * Constructs a new Prefix file filter for any of an array of prefixes.
      * <p>
      * The array is not cloned, so could be changed after constructing the
      * instance. This would be inadvisable however.
      * 
-     * @param prefixes  the prefixes to allow, null means none
+     * @param prefixes  the prefixes to allow, must not be null
+     * @throws IllegalArgumentException if the prefix array is null
      */
     public PrefixFileFilter(final String[] prefixes) {
         if (prefixes == null) {
@@ -114,7 +116,9 @@ public PrefixFileFilter(final String[] prefixes) {
     /**
      * Constructs a new Prefix file filter for a list of prefixes.
      * 
-     * @param prefixes  the prefixes to allow, null means none
+     * @param prefixes  the prefixes to allow, must not be null
+     * @throws IllegalArgumentException if the prefix list is null
+     * @throws ClassCastException if the list does not contain Strings
      */
     public PrefixFileFilter(final List prefixes) {
         if (prefixes == null) {
@@ -124,7 +128,7 @@ public PrefixFileFilter(final List prefixes) {
     }
 
     /**
-     * Checks to see if the filename ends with the prefix.
+     * Checks to see if the filename starts with the prefix.
      * 
      * @param file  the File to check
      * @return true if the filename starts with one of our prefixes

src/java/org/apache/commons/io/filefilter/SuffixFileFilter.java

@@ -57,23 +57,22 @@
 import java.util.List;
 
 /**
- * This filters files based on the suffix (what the filename
- * ends with). This is used in retrieving all the files of a
- * particular type.
+ * Filters files based on the suffix (what the filename ends with).
+ * This is used in retrieving all the files of a particular type.
  * <p>
  * For example, to retrieve and print all <code>*.java</code> files 
  * in the current directory:
  *
  * <pre>
  * File dir = new File(".");
- * String[] files = dir.list( new SuffixFileFilter( new String[]{".java"} ) );
+ * String[] files = dir.list( new SuffixFileFilter(".java") );
  * for (int i = 0; i &lt; files.length; i++) {
  *     System.out.println(files[i]);
  * }
  * </pre>
  *
  * @since Commons IO 1.0
- * @version $Revision: 1.2 $ $Date: 2003/07/27 17:11:38 $
+ * @version $Revision: 1.3 $ $Date: 2003/09/20 19:52:38 $
  * 
  * @author Henri Yandell
  * @author Stephen Colebourne
@@ -90,6 +89,7 @@ public class SuffixFileFilter extends AbstractFileFilter {
      * Constructs a new Suffix file filter for a single extension.
      * 
      * @param suffix  the suffix to allow, must not be null
+     * @throws IllegalArgumentException if the suffix is null
      */
     public SuffixFileFilter(final String suffix) {
         if (suffix == null) {
@@ -105,6 +105,7 @@ public SuffixFileFilter(final String suffix) {
      * instance. This would be inadvisable however.
      * 
      * @param suffixes  the suffixes to allow, must not be null
+     * @throws IllegalArgumentException if the suffix array is null
      */
     public SuffixFileFilter(final String[] suffixes) {
         if (suffixes == null) {
@@ -117,6 +118,8 @@ public SuffixFileFilter(final String[] suffixes) {
      * Constructs a new Suffix file filter for a list of suffixes.
      * 
      * @param suffixes  the suffixes to allow, must not be null
+     * @throws IllegalArgumentException if the suffix list is null
+     * @throws ClassCastException if the list does not contain Strings
      */
     public SuffixFileFilter(final List suffixes) {
         if (suffixes == null) {

src/java/org/apache/commons/io/filefilter/TrueFileFilter.java

@@ -1,7 +1,7 @@
 /* ====================================================================
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2003 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -59,7 +59,7 @@
  * A file filter that always returns true.
  * 
  * @since Commons IO 1.0
- * @version $Revision: 1.2 $ $Date: 2003/07/27 17:11:38 $
+ * @version $Revision: 1.3 $ $Date: 2003/09/20 19:52:38 $
  * 
  * @author Henri Yandell
  * @author Stephen Colebourne
@@ -76,7 +76,7 @@ protected TrueFileFilter() {
     }
 
     /**
-     * Return true.
+     * Returns true.
      * 
      * @param file  the file to check
      * @return true
@@ -86,7 +86,7 @@ public boolean accept(File file) {
     }
 
     /**
-     * Return true.
+     * Returns true.
      * 
      * @param dir  the directory to check
      * @param name  the filename