org.apache.commons.io.filefilter

Class HiddenFileFilter

java.lang.Object

org.apache.commons.io.filefilter.AbstractFileFilter

org.apache.commons.io.filefilter.HiddenFileFilter

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 HiddenFileFilter
extends AbstractFileFilter
implements java.io.Serializable

This filter accepts Files that are hidden.

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

Using Classic IO

 File dir = FileUtils.current();
 String[] files = dir.list(HiddenFileFilter.HIDDEN);
 for (String file : files) {
     System.out.println(file);
 }
 

Example, showing how to print out a list of the current directory's visible (i.e. not hidden) files:

 File dir = FileUtils.current();
 String[] files = dir.list(HiddenFileFilter.VISIBLE);
 for (String file : files) {
     System.out.println(file);
 }
 

Using NIO

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

Deprecating Serialization

Serialization is deprecated and will be removed in 3.0.

Since:

1.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IOFileFilter	HIDDEN Singleton instance of hidden filter
static IOFileFilter	VISIBLE Singleton instance of visible filter

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

EMPTY_STRING_ARRAY

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.io.File file) Checks to see if the file is hidden.
java.nio.file.FileVisitResult	accept(java.nio.file.Path file, java.nio.file.attribute.BasicFileAttributes attributes) Checks to see if the file is hidden.

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

accept, postVisitDirectory, preVisitDirectory, toString, visitFile, visitFileFailed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

and, negate, or

Field Detail

HIDDEN

public static final IOFileFilter HIDDEN

Singleton instance of hidden filter

VISIBLE

public static final IOFileFilter VISIBLE

Singleton instance of visible filter

Method Detail

accept

public boolean accept(java.io.File file)

Checks to see if the file is hidden.

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 is hidden, otherwise false.

accept

public java.nio.file.FileVisitResult accept(java.nio.file.Path file,
                                            java.nio.file.attribute.BasicFileAttributes attributes)

Checks to see if the file is hidden.

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 is hidden, otherwise false.

Since:

2.9.0