KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > discovery > Resource


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;
59
60 import java.io.IOException JavaDoc;
61 import java.io.InputStream JavaDoc;
62 import java.net.URL JavaDoc;
63
64 import org.apache.commons.discovery.log.DiscoveryLogFactory;
65 import org.apache.commons.discovery.resource.DiscoverResources;
66 import org.apache.commons.logging.Log;
67
68
69 /**
70  * 'Resource' located by discovery.
71  * Naming of methods becomes a real pain ('getClass()')
72  * so I've patterned this after ClassLoader...
73  *
74  * I think it works well as it will give users a point-of-reference.
75  *
76  * @author Craig R. McClanahan
77  * @author Costin Manolache
78  * @author Richard A. Sitze
79  */
80 public class Resource
81 {
82     private static Log log = DiscoveryLogFactory.newLog(DiscoverResources.class);
83     public static void setLog(Log _log) {
84         log = _log;
85     }
86     protected final String JavaDoc name;
87     protected final URL JavaDoc resource;
88     protected final ClassLoader JavaDoc loader;
89
90     public Resource(String JavaDoc resourceName, URL JavaDoc resource, ClassLoader JavaDoc loader) {
91         this.name = resourceName;
92         this.resource = resource;
93         this.loader = loader;
94
95         if (log.isDebugEnabled())
96             log.debug("new " + this);
97     }
98
99     /**
100      * Get the value of resourceName.
101      * @return value of resourceName.
102      */
103     public String JavaDoc getName() {
104         return name;
105     }
106     
107     /**
108      * Get the value of URL.
109      * @return value of URL.
110      */
111     public URL JavaDoc getResource() {
112         return resource;
113     }
114     
115     /**
116      * Get the value of URL.
117      * @return value of URL.
118      */
119     public InputStream JavaDoc getResourceAsStream() {
120         try {
121             return resource.openStream();
122         } catch (IOException JavaDoc e) {
123             return null; // ignore
124 }
125     }
126     
127     /**
128      * Get the value of loader.
129      * @return value of loader.
130      */
131     public ClassLoader JavaDoc getClassLoader() {
132         return loader ;
133     }
134 }
135
Popular Tags