001: /*
002: * $Id: RegexFilenameFilter.java,v 1.9 2003/11/07 20:16:23 dfs Exp $
003: *
004: * ====================================================================
005: * The Apache Software License, Version 1.1
006: *
007: * Copyright (c) 2000 The Apache Software Foundation. All rights
008: * reserved.
009: *
010: * Redistribution and use in source and binary forms, with or without
011: * modification, are permitted provided that the following conditions
012: * are met:
013: *
014: * 1. Redistributions of source code must retain the above copyright
015: * notice, this list of conditions and the following disclaimer.
016: *
017: * 2. Redistributions in binary form must reproduce the above copyright
018: * notice, this list of conditions and the following disclaimer in
019: * the documentation and/or other materials provided with the
020: * distribution.
021: *
022: * 3. The end-user documentation included with the redistribution,
023: * if any, must include the following acknowledgment:
024: * "This product includes software developed by the
025: * Apache Software Foundation (http://www.apache.org/)."
026: * Alternately, this acknowledgment may appear in the software itself,
027: * if and wherever such third-party acknowledgments normally appear.
028: *
029: * 4. The names "Apache" and "Apache Software Foundation", "Jakarta-Oro"
030: * must not be used to endorse or promote products derived from this
031: * software without prior written permission. For written
032: * permission, please contact apache@apache.org.
033: *
034: * 5. Products derived from this software may not be called "Apache"
035: * or "Jakarta-Oro", nor may "Apache" or "Jakarta-Oro" appear in their
036: * name, without prior written permission of the Apache Software Foundation.
037: *
038: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
039: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
040: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
041: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
042: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
043: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
044: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
045: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
046: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
047: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
048: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
049: * SUCH DAMAGE.
050: * ====================================================================
051: *
052: * This software consists of voluntary contributions made by many
053: * individuals on behalf of the Apache Software Foundation. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.oro.io;
059:
060: import java.io.*;
061:
062: import org.apache.oro.text.regex.*;
063: import org.apache.oro.text.*;
064:
065: /**
066: * RegexFilenameFilter is the base class for a set of FilenameFilter
067: * implementations that filter based on a regular expression.
068: *
069: * @version @version@
070: * @since 1.0
071: * @see Perl5FilenameFilter
072: * @see AwkFilenameFilter
073: * @see GlobFilenameFilter
074: */
075: public abstract class RegexFilenameFilter implements FilenameFilter,
076: FileFilter {
077: PatternCache _cache;
078: PatternMatcher _matcher;
079: Pattern _pattern;
080:
081: RegexFilenameFilter(PatternCache cache, PatternMatcher matcher,
082: String regex) {
083: _cache = cache;
084: _matcher = matcher;
085: setFilterExpression(regex);
086: }
087:
088: RegexFilenameFilter(PatternCache cache, PatternMatcher matcher,
089: String regex, int options) {
090: _cache = cache;
091: _matcher = matcher;
092: setFilterExpression(regex, options);
093: }
094:
095: RegexFilenameFilter(PatternCache cache, PatternMatcher matcher) {
096: this (cache, matcher, "");
097: }
098:
099: /**
100: * Set the regular expression on which to filter.
101: * <p>
102: * @param regex The regular expression on which to filter.
103: * @exception MalformedCachePatternException If there is an error in
104: * compiling the regular expression. This need not be caught if
105: * you are using a hard-coded expression that you know is correct.
106: * But for robustness and reliability you should catch this exception
107: * for dynamically entered expressions determined at runtime.
108: */
109: public void setFilterExpression(String regex)
110: throws MalformedCachePatternException {
111: _pattern = _cache.getPattern(regex);
112: }
113:
114: /**
115: * Set the regular expression on which to filter along with any
116: * special options to use when compiling the expression.
117: * <p>
118: * @param regex The regular expression on which to filter.
119: * @param options A set of compilation options specific to the regular
120: * expression grammar being used.
121: * @exception MalformedCachePatternException If there is an error in
122: * compiling the regular expression. This need not be caught if
123: * you are using a hard-coded expression that you know is correct.
124: * But for robustness and reliability you should catch this exception
125: * for dynamically entered expressions determined at runtime.
126: */
127: public void setFilterExpression(String regex, int options)
128: throws MalformedCachePatternException {
129: _pattern = _cache.getPattern(regex, options);
130: }
131:
132: /**
133: * Filters a filename. Tests if the filename EXACTLY matches the pattern
134: * contained by the filter. The directory argument is not examined.
135: * Conforms to the java.io.FilenameFilter interface.
136: * <p>
137: * @param dir The directory containing the file.
138: * @param filename The name of the file.
139: * @return True if the filename EXACTLY matches the pattern, false if not.
140: */
141: public boolean accept(File dir, String filename) {
142: synchronized (_matcher) {
143: return _matcher.matches(filename, _pattern);
144: }
145: }
146:
147: /**
148: * Filters a filename. Tests if the filename EXACTLY matches the pattern
149: * contained by the filter. The filename is defined as pathname.getName().
150: * Conforms to the java.io.FileFilter interface.
151: * <p>
152: * @param pathname The file pathname.
153: * @return True if the filename EXACTLY matches the pattern, false if not.
154: */
155: public boolean accept(File pathname) {
156: synchronized (_matcher) {
157: return _matcher.matches(pathname.getName(), _pattern);
158: }
159: }
160: }
|