net.pandoragames.far.ui

Interface DirectoryFilter

All Known Subinterfaces:

FileFilter, FindFilter

All Known Implementing Classes:

FindForm

public interface DirectoryFilter

Data for a file filter that tests the files directory.

Author:

Olivier Wehner

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	getBaseDirectory() Returns the base directory.
FileNamePattern	getDirectoryPattern() Returns the directory search pattern currently set or null.
int	getMaxDepth() Returns the maximal search depth.
boolean	isExcludeMatchingDirectories() Control flag for the directory pattern.
boolean	isIncludeSubDirs() Should files in subdirectories of the base directory pass the filter?

Method Detail

getBaseDirectory

java.io.File getBaseDirectory()

Returns the base directory. Only files in this directory (or below if the includeSubDirs flag is set) will pass the filter.

Returns:

base directory

isIncludeSubDirs

boolean isIncludeSubDirs()

Should files in subdirectories of the base directory pass the filter?

Returns:

include subdirectories

getMaxDepth

int getMaxDepth()

Returns the maximal search depth. The default is 256.

Returns:

maximal search depth

getDirectoryPattern

FileNamePattern getDirectoryPattern()

Returns the directory search pattern currently set or null. The pattern is matched against every subdirectory beyond the base directory. Depending on the value of the exclude-matching-directories flag, matching directories will be excluded from search, or only files with matching ancestor directories will be included.

Returns:

directory name pattern

isExcludeMatchingDirectories

boolean isExcludeMatchingDirectories()

Control flag for the directory pattern. If this flag is set, directories matching the directory pattern will be excluded from the search. Otherwise, only files in or under a matching directory (i.e. with matching ancestor directory) will be included in the search result. If the directory pattern is not set (null), this flag has no effect.

Returns:

should directories matching the directory pattern be excluded