Package org.apache.commons.io.filefilter

Class SuffixFileFilter

java.lang.Object
org.apache.commons.io.filefilter.AbstractFileFilter
org.apache.commons.io.filefilter.SuffixFileFilter
All Implemented Interfaces:
FileFilter, FilenameFilter, Serializable, FileVisitor<Path>, PathMatcher, PathFilter, PathVisitor, IOFileFilter
public class SuffixFileFilter extends AbstractFileFilter implements Serializable
Filters files based on the suffix (what the file name ends with). This is used in retrieving all the files of a particular type.

For example, to retrieve and print all *.java files in the current directory:

Using Classic IO

 File dir = FileUtils.current();
 String[] files = dir.list(new SuffixFileFilter(".java"));
 for (String file : files) {
     System.out.println(file);
 }

Using NIO

 final Path dir = PathUtils.current();
 final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(new SuffixFileFilter(".java"));
 //
 // Walk one dir
 Files.walkFileTree(dir, Collections.emptySet(), 1, visitor);
 System.out.println(visitor.getPathCounters());
 System.out.println(visitor.getFileList());
 //
 visitor.getPathCounters().reset();
 //
 // Walk dir tree
 Files.walkFileTree(dir, visitor);
 System.out.println(visitor.getPathCounters());
 System.out.println(visitor.getDirList());
 System.out.println(visitor.getFileList());

Deprecating Serialization

Serialization is deprecated and will be removed in 3.0.

Since:
1.0
See Also:

  • Constructor Details

    • SuffixFileFilter

      public SuffixFileFilter(List<String> suffixes)
      Constructs a new Suffix file filter for a list of suffixes.
      Parameters:
      suffixes - the suffixes to allow, must not be null
      Throws:
      IllegalArgumentException - if the suffix list is null
      ClassCastException - if the list does not contain Strings

    • SuffixFileFilter

      public SuffixFileFilter(List<String> suffixes, IOCase ioCase)
      Constructs a new Suffix file filter for a list of suffixes specifying case-sensitivity.
      Parameters:
      suffixes - the suffixes to allow, must not be null
      ioCase - how to handle case sensitivity, null means case-sensitive
      Throws:
      IllegalArgumentException - if the suffix list is null
      ClassCastException - if the list does not contain Strings
      Since:
      1.4

    • SuffixFileFilter

      public SuffixFileFilter(String suffix)
      Constructs a new Suffix file filter for a single extension.
      Parameters:
      suffix - the suffix to allow, must not be null
      Throws:
      IllegalArgumentException - if the suffix is null

    • SuffixFileFilter

      public SuffixFileFilter(String... suffixes)
      Constructs a new Suffix file filter for an array of suffixes.

      The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.

      Parameters:
      suffixes - the suffixes to allow, must not be null
      Throws:
      NullPointerException - if the suffix array is null

    • SuffixFileFilter

      public SuffixFileFilter(String suffix, IOCase ioCase)
      Constructs a new Suffix file filter for a single extension specifying case-sensitivity.
      Parameters:
      suffix - the suffix to allow, must not be null
      ioCase - how to handle case sensitivity, null means case-sensitive
      Throws:
      NullPointerException - if the suffix is null
      Since:
      1.4

    • SuffixFileFilter

      public SuffixFileFilter(String[] suffixes, IOCase ioCase)
      Constructs a new Suffix file filter for an array of suffixes specifying case-sensitivity.
      Parameters:
      suffixes - the suffixes to allow, must not be null
      ioCase - how to handle case sensitivity, null means case-sensitive
      Throws:
      NullPointerException - if the suffix array is null
      Since:
      1.4

  • Method Details