Class PrefixFileFilter

java.lang.Object
org.apache.commons.vfs2.filter.PrefixFileFilter
All Implemented Interfaces:
Serializable, FileFilter

public class PrefixFileFilter extends Object implements FileFilter, Serializable
Filters file names for a certain prefix.

For example, to print all files and directories in the current directory whose name starts with a .:

 FileSystemManager fsManager = VFS.getManager();
 FileObject dir = fsManager.toFileObject(new File("."));
 FileObject[] files = dir.findFiles(new FileFilterSelector(new PrefixFileFilter(".")));
 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.
    • prefixes

      private final List<String> prefixes
      The file name prefixes to search for.
  • Constructor Details

    • PrefixFileFilter

      public PrefixFileFilter(List<String> prefixes)
      Constructs a new Prefix file filter for a list of prefixes.
      Parameters:
      prefixes - the prefixes to allow, must not be null
    • PrefixFileFilter

      public PrefixFileFilter(IOCase caseSensitivity, List<String> prefixes)
      Constructs a new Prefix file filter for a list of prefixes specifying case-sensitivity.
      Parameters:
      caseSensitivity - how to handle case sensitivity, null means case-sensitive
      prefixes - the prefixes to allow, must not be null
    • PrefixFileFilter

      public PrefixFileFilter(String... prefixes)
      Constructs a new Prefix file filter for any of an array of prefixes.

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

      Parameters:
      prefixes - the prefixes to allow, must not be null
    • PrefixFileFilter

      public PrefixFileFilter(IOCase caseSensitivity, String... prefixes)
      Constructs a new Prefix file filter for any of an array of prefixes specifying case-sensitivity.
      Parameters:
      caseSensitivity - how to handle case sensitivity, null means case-sensitive
      prefixes - the prefixes to allow, must not be null
  • Method Details

    • accept

      public boolean accept(FileSelectInfo fileSelectInfo)
      Checks to see if the file name starts with the prefix.
      Specified by:
      accept in interface FileFilter
      Parameters:
      fileSelectInfo - the File to check
      Returns:
      true if the file name starts with one of our prefixes
    • toString

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