org.apache.oro.io
Class RegexFilenameFilter

java.lang.Object
  |
  +--org.apache.oro.io.RegexFilenameFilter
All Implemented Interfaces:
java.io.FilenameFilter
Direct Known Subclasses:
AwkFilenameFilter, GlobFilenameFilter, Perl5FilenameFilter

public abstract class RegexFilenameFilter
extends java.lang.Object
implements java.io.FilenameFilter

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

Version:
$Id: RegexFilenameFilter.java,v 1.1.1.1 2000/07/23 23:08:48 jon Exp $
Author:
Daniel F. Savarese
See Also:
Perl5FilenameFilter, AwkFilenameFilter, GlobFilenameFilter

Method Summary
 boolean accept(java.io.File dir, java.lang.String filename)
          Filters a filename.
 void setFilterExpression(java.lang.String regex)
          Set the regular expression on which to filter.
 void setFilterExpression(java.lang.String regex, int options)
          Set the regular expression on which to filter along with any special options to use when compiling the expression.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setFilterExpression

public void setFilterExpression(java.lang.String regex)
                         throws MalformedCachePatternException
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(java.lang.String regex,
                                int options)
                         throws MalformedCachePatternException
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.

accept

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

Specified by:
accept in interface java.io.FilenameFilter
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.


Copyright © 2000 Apache Software Foundation. All Rights Reserved.