Package org.apache.commons.io.filefilter

Class NameFileFilter

java.lang.Object
org.apache.commons.io.filefilter.AbstractFileFilter
org.apache.commons.io.filefilter.NameFileFilter
All Implemented Interfaces:
FileFilter, FilenameFilter, Serializable, IOFileFilter
public class NameFileFilter extends AbstractFileFilter implements Serializable
Filters file names for a certain name.

For example, to print all files and directories in the current directory whose name is Test: 

 File dir = new File(".");
 String[] files = dir.list( new NameFileFilter("Test") );
 for ( int i = 0; i < files.length; i++ ) {
     System.out.println(files[i]);
 }
Since:
1.0
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • names

      private final String[] names
      The file names to search for

    • caseSensitivity

      private final IOCase caseSensitivity
      Whether the comparison is case sensitive.

  • Constructor Details

    • NameFileFilter

      public NameFileFilter(String name)
      Constructs a new case-sensitive name file filter for a single name.
      Parameters:
      name - the name to allow, must not be null
      Throws:
      IllegalArgumentException - if the name is null

    • NameFileFilter

      public NameFileFilter(String name, IOCase caseSensitivity)
      Construct a new name file filter specifying case-sensitivity.
      Parameters:
      name - the name to allow, must not be null
      caseSensitivity - how to handle case sensitivity, null means case-sensitive
      Throws:
      IllegalArgumentException - if the name is null

    • NameFileFilter

      public NameFileFilter(String... names)
      Constructs a new case-sensitive name file filter for an array of names.

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

      Parameters:
      names - the names to allow, must not be null
      Throws:
      IllegalArgumentException - if the names array is null

    • NameFileFilter

      public NameFileFilter(String[] names, IOCase caseSensitivity)
      Constructs a new name file filter for an array of names specifying case-sensitivity.
      Parameters:
      names - the names to allow, must not be null
      caseSensitivity - how to handle case sensitivity, null means case-sensitive
      Throws:
      IllegalArgumentException - if the names array is null

    • NameFileFilter

      public NameFileFilter(List<String> names)
      Constructs a new case-sensitive name file filter for a list of names.
      Parameters:
      names - the names to allow, must not be null
      Throws:
      IllegalArgumentException - if the name list is null
      ClassCastException - if the list does not contain Strings

    • NameFileFilter

      public NameFileFilter(List<String> names, IOCase caseSensitivity)
      Constructs a new name file filter for a list of names specifying case-sensitivity.
      Parameters:
      names - the names to allow, must not be null
      caseSensitivity - how to handle case sensitivity, null means case-sensitive
      Throws:
      IllegalArgumentException - if the name list is null
      ClassCastException - if the list does not contain Strings

  • Method Details