org.apache.commons.vfs2.filter

Class HiddenFileFilter

java.lang.Object

org.apache.commons.vfs2.filter.HiddenFileFilter

All Implemented Interfaces:

Serializable, FileFilter

public class HiddenFileFilter
extends Object
implements FileFilter, Serializable

This filter accepts Files that are hidden.

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

 FileSystemManager fsManager = VFS.getManager();
 FileObject dir = fsManager.toFileObject(new File("."));
 FileObject[] files = dir.findFiles(new FileFilterSelector(HiddenFileFilter.HIDDEN));
 for (int i = 0; i < files.length; i++) {
     System.out.println(files[i]);
 }
 

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

 FileSystemManager fsManager = VFS.getManager();
 FileObject dir = fsManager.toFileObject(new File("."));
 FileObject[] files = dir.findFiles(new FileFilterSelector(HiddenFileFilter.VISIBLE));
 for (int i = 0; i < files.length; i++) {
     System.out.println(files[i]);
 }
 

Since:

2.4

Author:

This code was originally ported from Apache Commons IO File Filter

See Also:

"http://commons.apache.org/proper/commons-io/", Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HiddenFileFilter() Restrictive constructor.

Method Summary

Modifier and Type	Method and Description
boolean	accept(FileSelectInfo fileSelectInfo) Checks to see if the file is hidden.

Methods inherited from class java.lang.Object

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

Field Detail

HIDDEN

public static final FileFilter HIDDEN

Singleton instance of hidden filter.

VISIBLE

public static final FileFilter VISIBLE

Singleton instance of visible filter.

Constructor Detail

HiddenFileFilter

protected HiddenFileFilter()

Restrictive constructor.

Method Detail

accept

public boolean accept(FileSelectInfo fileSelectInfo)
               throws FileSystemException

Checks to see if the file is hidden. Non existing files won't be accepted.

Specified by:

accept in interface FileFilter

Parameters:

fileSelectInfo - the File to check

Returns:

true if the file is hidden, otherwise false.

Throws:

FileSystemException - Thrown for file system errors.