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, FileVisitor<Path>, PathFilter, PathVisitor, 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`:

  ## Using Classic IO

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

  ## Using NIO

       final Path dir = PathUtils.current();
       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());

  ## Deprecating Serialization

  Serialization is deprecated and will be removed in 3.0.

  Since:
    1.0
  See Also:
    `FileFilterUtils.nameFileFilter(String)`, `FileFilterUtils.nameFileFilter(String, IOCase)`, Serialized Form

- - ### Field Summary

    - ### Fields inherited from interface org.apache.commons.io.filefilter.IOFileFilter

      `EMPTY_STRING_ARRAY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `NameFileFilter(List<String> names)` Constructs a new case-sensitive name file filter for a list of names.
    `NameFileFilter(List<String> names, IOCase ioCase)` Constructs a new name file filter for a list of names specifying case-sensitivity.
    `NameFileFilter(String... names)` Constructs a new case-sensitive name file filter for an array of names.
    `NameFileFilter(String name)` Constructs a new case-sensitive name file filter for a single name.
    `NameFileFilter(String[] names, IOCase ioCase)` Constructs a new name file filter for an array of names specifying case-sensitivity.
    `NameFileFilter(String name, IOCase ioCase)` Constructs a new name file filter specifying case-sensitivity.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `accept(File file)` Checks to see if the file name matches.
    `boolean` | `accept(File dir, String name)` Checks to see if the file name matches.
    `FileVisitResult` | `accept(Path file, BasicFileAttributes attributes)` Checks to see if the file name matches.
    `String` | `toString()` Provide a String representation of this file filter.

    - ### Methods inherited from class org.apache.commons.io.filefilter.AbstractFileFilter

      `handle, postVisitDirectory, preVisitDirectory, visitFile, visitFileFailed`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface org.apache.commons.io.filefilter.IOFileFilter

      `and, negate, or`

- - ### Constructor Detail

    - #### 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 ioCase)

      Constructs a new name file filter for a list of names specifying case-sensitivity.
      Parameters:
        `names` - the names to allow, must not be null
        `ioCase` - how to handle case sensitivity, null means case-sensitive
      Throws:
        `NullPointerException` - if the name list is null
        `ClassCastException` - if the list does not contain Strings

    - #### 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... 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 name,
                                IOCase ioCase)

      Constructs a new name file filter specifying case-sensitivity.
      Parameters:
        `name` - the name to allow, must not be null
        `ioCase` - how to handle case sensitivity, null means case-sensitive
      Throws:
        `NullPointerException` - if the name is null

    - #### NameFileFilter

          public NameFileFilter(String[] names,
                                IOCase ioCase)

      Constructs a new name file filter for an array of names specifying case-sensitivity.
      Parameters:
        `names` - the names to allow, must not be null
        `ioCase` - how to handle case sensitivity, null means case-sensitive
      Throws:
        `NullPointerException` - if the names array is null

  - ### Method Detail

    - #### accept

          public boolean accept(File file)

      Checks to see if the file name matches.
      Specified by:
        `accept` in interface `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(File dir,
                                String name)

      Checks to see if the file name matches.
      Specified by:
        `accept` in interface `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 FileVisitResult accept(Path file,
                                        BasicFileAttributes attributes)

      Checks to see if the file name matches.
      Specified by:
        `accept` in interface `PathFilter`
      Specified by:
        `accept` in interface `IOFileFilter`
      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 String toString()

      Provide a String representation of this file filter.
      Overrides:
        `toString` in class `AbstractFileFilter`
      Returns:
        a String representation

Copyright © 2002–2023 The Apache Software Foundation. All rights reserved.