Package org.apache.rat.walker

Class NameBasedHiddenFileFilter

java.lang.Object
org.apache.commons.io.filefilter.AbstractFileFilter
org.apache.rat.walker.NameBasedHiddenFileFilter
All Implemented Interfaces:
FileFilter, FilenameFilter, Serializable, FileVisitor<Path>, PathMatcher, org.apache.commons.io.file.PathFilter, org.apache.commons.io.file.PathVisitor, org.apache.commons.io.filefilter.IOFileFilter
public class NameBasedHiddenFileFilter extends org.apache.commons.io.filefilter.AbstractFileFilter implements Serializable
This filter accepts Files that are hidden, e.g. file name starts with .

Example, showing how to print out a list of the current directory's hidden files:

Using Classic IO

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

Using NIO

 final Path dir = Paths.get("");
 final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(NameBasedHiddenFileFilter.HIDDEN);
 //
 // 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());
See Also:
Serialized Form

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static org.apache.commons.io.filefilter.IOFileFilter
    HIDDEN
    Singleton instance of hidden filter.

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

    EMPTY_STRING_ARRAY

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    NameBasedHiddenFileFilter()
    Restrictive constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    accept​(File file)
    Checks to see if the file is hidden, e.g. file name starts with .

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

    accept, handle, postVisitDirectory, preVisitDirectory, toString, 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

    accept, and, matches, negate, or

  • Field Details

    • HIDDEN

      public static final org.apache.commons.io.filefilter.IOFileFilter HIDDEN
      Singleton instance of hidden filter.

  • Constructor Details

    • NameBasedHiddenFileFilter

      protected NameBasedHiddenFileFilter()
      Restrictive constructor.

  • Method Details

    • accept

      public boolean accept​(File file)
      Checks to see if the file is hidden, e.g. file name starts with .
      Specified by:
      accept in interface FileFilter
      Specified by:
      accept in interface org.apache.commons.io.filefilter.IOFileFilter
      Overrides:
      accept in class org.apache.commons.io.filefilter.AbstractFileFilter
      Parameters:
      file - the File to check
      Returns:
      true if the file is hidden (file name starting with .), false else