Class NameFileFilter

java.lang.Object
org.apache.commons.vfs2.filter.NameFileFilter
All Implemented Interfaces:
Serializable, FileFilter
public class NameFileFilter extends Object implements FileFilter, Serializable
Filters file names for a certain name.

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

FileSystemManager fsManager = VFS.getManager();
FileObject dir = fsManager.toFileObject(new File("."));
FileObject[] files = dir.findFiles(new FileFilterSelector(new NameFileFilter("Test")));
for (int i = 0; i < files.length; i++) {
    System.out.println(files[i]);
}
Since:
2.4
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • caseSensitivity

      private final IOCase caseSensitivity
      Whether the comparison is case sensitive.

    • names

      private final List<String> names
      The file names to search for.

  • Constructor Details

    • 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

    • NameFileFilter

      public NameFileFilter(IOCase caseSensitivity, List<String> names)
      Constructs a new name file filter for a list of names specifying case-sensitivity.
      Parameters:
      caseSensitivity - how to handle case sensitivity, null means case-sensitive
      names - the names to allow, must not be 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

    • NameFileFilter

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

  • Method Details

    • accept

      public boolean accept(FileSelectInfo fileSelectInfo)
      Checks to see if the file name matches.
      Specified by:
      accept in interface FileFilter
      Parameters:
      fileSelectInfo - the File to check
      Returns:
      true if the file name matches

    • toString

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