Package org.apache.commons.io.filefilter

Class NameFileFilter

  • All Implemented Interfaces:
    java.io.FileFilter, java.io.FilenameFilter, java.io.Serializable, java.nio.file.FileVisitor<java.nio.file.Path>, PathFilter, PathVisitor, IOFileFilter
    public class NameFileFilter
extends AbstractFileFilter
implements java.io.Serializable
    Filters file names for a certain name.

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

    Using Classic IO

     File dir = new File(".");
 String[] files = dir.list(new NameFileFilter("Test"));
 for (String file : files) {
     System.out.println(file);
 }

    Using NIO

     final Path dir = Paths.get("");
 final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(new NameFileFilter("Test"));
 //
 // 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());
    Since:
    1.0
    See Also:
    FileFilterUtils.nameFileFilter(String), FileFilterUtils.nameFileFilter(String, IOCase), Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      NameFileFilter​(java.lang.String name)
      Constructs a new case-sensitive name file filter for a single name.
      NameFileFilter​(java.lang.String... names)
      Constructs a new case-sensitive name file filter for an array of names.
      NameFileFilter​(java.lang.String[] names, IOCase caseSensitivity)
      Constructs a new name file filter for an array of names specifying case-sensitivity.
      NameFileFilter​(java.lang.String name, IOCase caseSensitivity)
      Construct a new name file filter specifying case-sensitivity.
      NameFileFilter​(java.util.List<java.lang.String> names)
      Constructs a new case-sensitive name file filter for a list of names.
      NameFileFilter​(java.util.List<java.lang.String> names, IOCase caseSensitivity)
      Constructs a new name file filter for a list of names 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 matches.
      boolean accept​(java.io.File dir, java.lang.String name)
      Checks to see if the file name matches.
      java.nio.file.FileVisitResult accept​(java.nio.file.Path file, java.nio.file.attribute.BasicFileAttributes attributes)
      Checks to see if the file name matches.
      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

      • NameFileFilter

        public NameFileFilter​(java.util.List<java.lang.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:
        java.lang.IllegalArgumentException - if the name list is null
        java.lang.ClassCastException - if the list does not contain Strings

      • NameFileFilter

        public NameFileFilter​(java.util.List<java.lang.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:
        java.lang.IllegalArgumentException - if the name list is null
        java.lang.ClassCastException - if the list does not contain Strings

      • NameFileFilter

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

      • NameFileFilter

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

      • NameFileFilter

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

      • NameFileFilter

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

    • Method Detail

      • accept

        public boolean accept​(java.io.File file)
        Checks to see if the file name matches.
        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 matches

      • accept

        public boolean accept​(java.io.File dir,
                      java.lang.String name)
        Checks to see if the file name matches.
        Specified by:
        accept in interface java.io.FilenameFilter
        Specified by:
        accept in interface IOFileFilter
        Overrides:
        accept in class AbstractFileFilter
        Parameters:
        dir - the File directory (ignored)
        name - the file name
        Returns:
        true if the file name matches

      • accept

        public java.nio.file.FileVisitResult accept​(java.nio.file.Path file,
                                            java.nio.file.attribute.BasicFileAttributes attributes)
        Checks to see if the file name matches.
        Specified by:
        accept in interface IOFileFilter
        Specified by:
        accept in interface PathFilter
        Parameters:
        file - the File to check
        attributes - the file's basic attributes (TODO may be null).
        Returns:
        true if the file name matches
        Since:
        2.9.0

      • toString

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