KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > oro > io > RegexFilenameFilter


1 package org.apache.oro.io;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2000 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation", "Jakarta-Oro"
29  * must not be used to endorse or promote products derived from this
30  * software without prior written permission. For written
31  * permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache"
34  * or "Jakarta-Oro", nor may "Apache" or "Jakarta-Oro" appear in their
35  * name, without prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  *
56  * Portions of this software are based upon software originally written
57  * by Daniel F. Savarese. We appreciate his contributions.
58  */
59
60 import java.io.*;
61
62 import org.apache.oro.text.regex.*;
63 import org.apache.oro.text.*;
64
65 /**
66  * RegexFilenameFilter is the base class for a set of FilenameFilter
67  * implementations that filter based on a regular expression.
68
69  @author <a HREF="dfs@savarese.org">Daniel F. Savarese</a>
70  @version $Id: RegexFilenameFilter.java,v 1.1.1.1 2000/07/23 23:08:48 jon Exp $
71
72  * @see Perl5FilenameFilter
73  * @see AwkFilenameFilter
74  * @see GlobFilenameFilter
75  */
76 public abstract class RegexFilenameFilter implements FilenameFilter {
77   PatternCache _cache;
78   PatternMatcher _matcher;
79   Pattern _pattern;
80
81   RegexFilenameFilter(PatternCache cache, PatternMatcher matcher, String JavaDoc regex)
82   {
83     _cache = cache;
84     _matcher = matcher;
85     setFilterExpression(regex);
86   }
87
88   RegexFilenameFilter(PatternCache cache, PatternMatcher matcher,
89               String JavaDoc regex, int options)
90   {
91     _cache = cache;
92     _matcher = matcher;
93     setFilterExpression(regex);
94   }
95
96   RegexFilenameFilter(PatternCache cache, PatternMatcher matcher) {
97     this(cache, matcher, "");
98   }
99
100   /**
101    * Set the regular expression on which to filter.
102    * <p>
103    * @param regex The regular expression on which to filter.
104    * @exception MalformedCachePatternException If there is an error in
105    * compiling the regular expression. This need not be caught if
106    * you are using a hard-coded expression that you know is correct.
107    * But for robustness and reliability you should catch this exception
108    * for dynamically entered expressions determined at runtime.
109    */
110   public void setFilterExpression(String JavaDoc regex)
111        throws MalformedCachePatternException
112   {
113     _pattern = _cache.getPattern(regex);
114   }
115
116   /**
117    * Set the regular expression on which to filter along with any
118    * special options to use when compiling the expression.
119    * <p>
120    * @param regex The regular expression on which to filter.
121    * @param options A set of compilation options specific to the regular
122    * expression grammar being used.
123    * @exception MalformedCachePatternException If there is an error in
124    * compiling the regular expression. This need not be caught if
125    * you are using a hard-coded expression that you know is correct.
126    * But for robustness and reliability you should catch this exception
127    * for dynamically entered expressions determined at runtime.
128    */
129   public void setFilterExpression(String JavaDoc regex, int options)
130        throws MalformedCachePatternException
131   {
132     _pattern = _cache.getPattern(regex, options);
133   }
134
135   /**
136    * Filters a filename. Tests if the filename EXACTLY matches the pattern
137    * contained by the filter. The directory argument is not examined.
138    * <p>
139    * @param dir The directory containing the file.
140    * @param filename The name of the file.
141    * @return True if the filename EXACTLY matches the pattern, false if not.
142    */
143   public boolean accept(File dir, String JavaDoc filename) {
144     synchronized(_matcher) {
145       return _matcher.matches(filename, _pattern);
146     }
147   }
148 }
149
Popular Tags