org.apache.oro.io

Class RegexFilenameFilter

public abstract class RegexFilenameFilter extends Object implements FilenameFilter, FileFilter

RegexFilenameFilter is the base class for a set of FilenameFilter implementations that filter based on a regular expression.

Since: 1.0

Version: 2.0.8

See Also: Perl5FilenameFilter AwkFilenameFilter GlobFilenameFilter

Method Summary
booleanaccept(File dir, String filename)
Filters a filename.
booleanaccept(File pathname)
Filters a filename.
voidsetFilterExpression(String regex)
Set the regular expression on which to filter.
voidsetFilterExpression(String regex, int options)
Set the regular expression on which to filter along with any special options to use when compiling the expression.

Method Detail

accept

public boolean accept(File dir, String filename)
Filters a filename. Tests if the filename EXACTLY matches the pattern contained by the filter. The directory argument is not examined. Conforms to the java.io.FilenameFilter interface.

Parameters: dir The directory containing the file. filename The name of the file.

Returns: True if the filename EXACTLY matches the pattern, false if not.

accept

public boolean accept(File pathname)
Filters a filename. Tests if the filename EXACTLY matches the pattern contained by the filter. The filename is defined as pathname.getName(). Conforms to the java.io.FileFilter interface.

Parameters: pathname The file pathname.

Returns: True if the filename EXACTLY matches the pattern, false if not.

setFilterExpression

public void setFilterExpression(String regex)
Set the regular expression on which to filter.

Parameters: regex The regular expression on which to filter.

Throws: MalformedCachePatternException If there is an error in compiling the regular expression. This need not be caught if you are using a hard-coded expression that you know is correct. But for robustness and reliability you should catch this exception for dynamically entered expressions determined at runtime.

setFilterExpression

public void setFilterExpression(String regex, int options)
Set the regular expression on which to filter along with any special options to use when compiling the expression.

Parameters: regex The regular expression on which to filter. options A set of compilation options specific to the regular expression grammar being used.

Throws: MalformedCachePatternException If there is an error in compiling the regular expression. This need not be caught if you are using a hard-coded expression that you know is correct. But for robustness and reliability you should catch this exception for dynamically entered expressions determined at runtime.

Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.