Package org.apache.commons.io.filefilter

Class SuffixFileFilter

  • All Implemented Interfaces:
    java.io.FileFilter, java.io.FilenameFilter, java.io.Serializable, IOFileFilter
    public class SuffixFileFilter
extends AbstractFileFilter
implements java.io.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: 

     File dir = new File(".");
 String[] files = dir.list( new SuffixFileFilter(".java") );
 for (int i = 0; i < files.length; i++) {
     System.out.println(files[i]);
 }
    Since:
    1.0
    See Also:
    FileFilterUtils.suffixFileFilter(String), FileFilterUtils.suffixFileFilter(String, IOCase), Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      SuffixFileFilter​(java.lang.String suffix)
      Constructs a new Suffix file filter for a single extension.
      SuffixFileFilter​(java.lang.String... suffixes)
      Constructs a new Suffix file filter for an array of suffixes.
      SuffixFileFilter​(java.lang.String[] suffixes, IOCase caseSensitivity)
      Constructs a new Suffix file filter for an array of suffixes specifying case-sensitivity.
      SuffixFileFilter​(java.lang.String suffix, IOCase caseSensitivity)
      Constructs a new Suffix file filter for a single extension specifying case-sensitivity.
      SuffixFileFilter​(java.util.List<java.lang.String> suffixes)
      Constructs a new Suffix file filter for a list of suffixes.
      SuffixFileFilter​(java.util.List<java.lang.String> suffixes, IOCase caseSensitivity)
      Constructs a new Suffix file filter for a list of suffixes specifying case-sensitivity.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean accept​(java.io.File file)
      Checks to see if the file name ends with the suffix.
      boolean accept​(java.io.File file, java.lang.String name)
      Checks to see if the file name ends with the suffix.
      java.lang.String toString()
      Provide a String representation of this file filter.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • SuffixFileFilter

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

      • SuffixFileFilter

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

      • SuffixFileFilter

        public SuffixFileFilter​(java.lang.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:
        java.lang.IllegalArgumentException - if the suffix array is null

      • SuffixFileFilter

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

      • SuffixFileFilter

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

      • SuffixFileFilter

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

    • Method Detail

      • accept

        public boolean accept​(java.io.File file)
        Checks to see if the file name ends with the suffix.
        Specified by:
        accept in interface java.io.FileFilter
        Specified by:
        accept in interface IOFileFilter
        Overrides:
        accept in class AbstractFileFilter
        Parameters:
        file - the File to check
        Returns:
        true if the file name ends with one of our suffixes

      • accept

        public boolean accept​(java.io.File file,
                      java.lang.String name)
        Checks to see if the file name ends with the suffix.
        Specified by:
        accept in interface java.io.FilenameFilter
        Specified by:
        accept in interface IOFileFilter
        Overrides:
        accept in class AbstractFileFilter
        Parameters:
        file - the File directory
        name - the file name
        Returns:
        true if the file name ends with one of our suffixes

      • toString

        public java.lang.String toString()
        Provide a String representation of this file filter.
        Overrides:
        toString in class AbstractFileFilter
        Returns:
        a String representation