KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > discovery > resource > names > DiscoverNamesInFile


1 /*
2  * ====================================================================
3  *
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 1999-2002 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, if
22  * any, must include the following acknowlegement:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
29  * Foundation" must not be used to endorse or promote products derived
30  * from this 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  * nor may "Apache" appear in their names without prior written
35  * permission of the Apache Group.
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  */
57
58 package org.apache.commons.discovery.resource.names;
59
60 import java.io.BufferedReader JavaDoc;
61 import java.io.IOException JavaDoc;
62 import java.io.InputStream JavaDoc;
63 import java.io.InputStreamReader JavaDoc;
64
65 import org.apache.commons.discovery.Resource;
66 import org.apache.commons.discovery.ResourceDiscover;
67 import org.apache.commons.discovery.ResourceListener;
68 import org.apache.commons.discovery.ResourceNameDiscover;
69 import org.apache.commons.discovery.ResourceNameListener;
70 import org.apache.commons.discovery.log.DiscoveryLogFactory;
71 import org.apache.commons.discovery.resource.ClassLoaders;
72 import org.apache.commons.discovery.resource.DiscoverResources;
73 import org.apache.commons.logging.Log;
74
75
76
77 /**
78  * Discover ALL files of a given name, and return resource names
79  * contained within the set of files:
80  * <ul>
81  * <li>one resource name per line,</li>
82  * <li>whitespace ignored,</li>
83  * <li>comments begin with '#'</li>
84  * </ul>
85  *
86  * Default discoverer is DiscoverClassLoaderResources,
87  * but it can be set to any other.
88  *
89  * @author Richard A. Sitze
90  * @author Costin Manolache
91  * @author James Strachan
92  */
93 public class DiscoverNamesInFile extends ResourceNameDiscoverImpl
94     implements ResourceNameDiscover, ResourceNameListener, ResourceListener
95 {
96     private static Log log = DiscoveryLogFactory.newLog(DiscoverNamesInFile.class);
97     public static void setLog(Log _log) {
98         log = _log;
99     }
100     
101     private ResourceDiscover discoverResources;
102     
103     /**
104      * Construct a new resource discoverer
105      */
106     public DiscoverNamesInFile() {
107         this.discoverResources = new DiscoverResources();
108         this.discoverResources.setListener(this);
109     }
110     
111     /**
112      * Construct a new resource discoverer
113      */
114     public DiscoverNamesInFile(ClassLoaders loaders) {
115         this.discoverResources = new DiscoverResources(loaders);
116         this.discoverResources.setListener(this);
117     }
118
119     /**
120      * Specify set of class loaders to be used in searching.
121      */
122     public void setClassLoaders(ClassLoaders loaders) {
123         discoverResources.setClassLoaders(loaders);
124     }
125
126     /**
127      */
128     public boolean find(String JavaDoc fileName) {
129         if (log.isDebugEnabled())
130             log.debug("find: fileName='" + fileName + "'");
131             
132         return discoverResources.find(fileName);
133     }
134     
135     public boolean found(String JavaDoc resourceName) {
136         return find(resourceName);
137     }
138     
139     /**
140      * Read everything, no defering here..
141      * Ensure that files are closed before we leave.
142      */
143     public boolean found(Resource info) {
144         InputStream JavaDoc is = info.getResourceAsStream();
145         
146         if( is != null ) {
147             try {
148                 try {
149                     // This code is needed by EBCDIC and other
150 // strange systems. It's a fix for bugs
151 // reported in xerces
152 BufferedReader JavaDoc rd;
153                     try {
154                         rd = new BufferedReader JavaDoc(new InputStreamReader JavaDoc(is, "UTF-8"));
155                     } catch (java.io.UnsupportedEncodingException JavaDoc e) {
156                         rd = new BufferedReader JavaDoc(new InputStreamReader JavaDoc(is));
157                     }
158                     
159                     try {
160                         String JavaDoc resourceName;
161                         while( (resourceName = rd.readLine()) != null) {
162                             int idx = resourceName.indexOf('#');
163                             if (idx >= 0) {
164                                 resourceName = resourceName.substring(0, idx);
165                             }
166                             resourceName = resourceName.trim();
167     
168                             if (resourceName.length() != 0) {
169                                 if (log.isDebugEnabled())
170                                     log.debug("readResourceNames: found '" + resourceName + "'");
171
172                                 if (!notifyListener(resourceName)) {
173                                     return false;
174                                 }
175                             }
176                         }
177                     } finally {
178                         rd.close();
179                     }
180                 } finally {
181                     is.close();
182                 }
183             } catch (IOException JavaDoc e) {
184                 // ignore
185 }
186         }
187         
188         return true;
189     }
190 }
191
Popular Tags