1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (version 1.7.0_79) on Tue May 12 22:00:47 CEST 2015 -->
6 <meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
7 <title>ClasspathUrlFinder (scannotation 1.0.4 API)</title>
8 <meta name="date" content="2015-05-12">
9 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
12 <script type="text/javascript"><!--
13 if (location.href.indexOf('is-external=true') == -1) {
14 parent.document.title="ClasspathUrlFinder (scannotation 1.0.4 API)";
19 <div>JavaScript is disabled on your browser.</div>
21 <!-- ========= START OF TOP NAVBAR ======= -->
22 <div class="topNav"><a name="navbar_top">
24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
27 <ul class="navList" title="Navigation">
28 <li><a href="../../overview-summary.html">Overview</a></li>
29 <li><a href="package-summary.html">Package</a></li>
30 <li class="navBarCell1Rev">Class</li>
31 <li><a href="class-use/ClasspathUrlFinder.html">Use</a></li>
32 <li><a href="package-tree.html">Tree</a></li>
33 <li><a href="../../deprecated-list.html">Deprecated</a></li>
34 <li><a href="../../index-all.html">Index</a></li>
35 <li><a href="../../help-doc.html">Help</a></li>
40 <li><a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation"><span class="strong">Prev Class</span></a></li>
41 <li><a href="../../org/scannotation/WarUrlFinder.html" title="class in org.scannotation"><span class="strong">Next Class</span></a></li>
44 <li><a href="../../index.html?org/scannotation/ClasspathUrlFinder.html" target="_top">Frames</a></li>
45 <li><a href="ClasspathUrlFinder.html" target="_top">No Frames</a></li>
47 <ul class="navList" id="allclasses_navbar_top">
48 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
51 <script type="text/javascript"><!--
52 allClassesLink = document.getElementById("allclasses_navbar_top");
54 allClassesLink.style.display = "block";
57 allClassesLink.style.display = "none";
63 <ul class="subNavList">
64 <li>Summary: </li>
65 <li>Nested | </li>
66 <li>Field | </li>
67 <li><a href="#constructor_summary">Constr</a> | </li>
68 <li><a href="#method_summary">Method</a></li>
70 <ul class="subNavList">
71 <li>Detail: </li>
72 <li>Field | </li>
73 <li><a href="#constructor_detail">Constr</a> | </li>
74 <li><a href="#method_detail">Method</a></li>
77 <a name="skip-navbar_top">
80 <!-- ========= END OF TOP NAVBAR ========= -->
81 <!-- ======== START OF CLASS DATA ======== -->
83 <div class="subTitle">org.scannotation</div>
84 <h2 title="Class ClasspathUrlFinder" class="title">Class ClasspathUrlFinder</h2>
86 <div class="contentContainer">
87 <ul class="inheritance">
88 <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
90 <ul class="inheritance">
91 <li>org.scannotation.ClasspathUrlFinder</li>
95 <div class="description">
96 <ul class="blockList">
97 <li class="blockList">
100 <pre>public class <span class="strong">ClasspathUrlFinder</span>
101 extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
102 <div class="block">Various functions to locate URLs to scan</div>
103 <dl><dt><span class="strong">Version:</span></dt>
104 <dd>$Revision: 1 $</dd>
105 <dt><span class="strong">Author:</span></dt>
106 <dd><a href="mailto:bill@burkecentral.com">Bill Burke</a></dd></dl>
110 <div class="summary">
111 <ul class="blockList">
112 <li class="blockList">
113 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
114 <ul class="blockList">
115 <li class="blockList"><a name="constructor_summary">
118 <h3>Constructor Summary</h3>
119 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
120 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
122 <th class="colOne" scope="col">Constructor and Description</th>
124 <tr class="altColor">
125 <td class="colOne"><code><strong><a href="../../org/scannotation/ClasspathUrlFinder.html#ClasspathUrlFinder()">ClasspathUrlFinder</a></strong>()</code> </td>
130 <!-- ========== METHOD SUMMARY =========== -->
131 <ul class="blockList">
132 <li class="blockList"><a name="method_summary">
135 <h3>Method Summary</h3>
136 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
137 <caption><span>Methods</span><span class="tabEnd"> </span></caption>
139 <th class="colFirst" scope="col">Modifier and Type</th>
140 <th class="colLast" scope="col">Method and Description</th>
142 <tr class="altColor">
143 <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a></code></td>
144 <td class="colLast"><code><strong><a href="../../org/scannotation/ClasspathUrlFinder.html#findClassBase(java.lang.Class)">findClassBase</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> clazz)</code>
145 <div class="block">Find the classpath for the particular class</div>
148 <tr class="rowColor">
149 <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>[]</code></td>
150 <td class="colLast"><code><strong><a href="../../org/scannotation/ClasspathUrlFinder.html#findClassPaths()">findClassPaths</a></strong>()</code>
151 <div class="block">Uses the java.class.path system property to obtain a list of URLs that represent the CLASSPATH</div>
154 <tr class="altColor">
155 <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>[]</code></td>
156 <td class="colLast"><code><strong><a href="../../org/scannotation/ClasspathUrlFinder.html#findClassPaths(java.lang.String...)">findClassPaths</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... paths)</code>
157 <div class="block">Uses the java.class.path system property to obtain a list of URLs that represent the CLASSPATH
159 paths is used as a filter to only include paths that have the specific relative file within it</div>
162 <tr class="rowColor">
163 <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a></code></td>
164 <td class="colLast"><code><strong><a href="../../org/scannotation/ClasspathUrlFinder.html#findResourceBase(java.lang.String)">findResourceBase</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseResource)</code>
165 <div class="block">Find the classpath URL for a specific classpath resource.</div>
168 <tr class="altColor">
169 <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a></code></td>
170 <td class="colLast"><code><strong><a href="../../org/scannotation/ClasspathUrlFinder.html#findResourceBase(java.lang.String,%20java.lang.ClassLoader)">findResourceBase</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseResource,
171 <a href="http://java.sun.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code>
172 <div class="block">Find the classpath URL for a specific classpath resource.</div>
175 <tr class="rowColor">
176 <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>[]</code></td>
177 <td class="colLast"><code><strong><a href="../../org/scannotation/ClasspathUrlFinder.html#findResourceBases(java.lang.String)">findResourceBases</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseResource)</code>
178 <div class="block">Find the classpath URLs for a specific classpath resource.</div>
181 <tr class="altColor">
182 <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>[]</code></td>
183 <td class="colLast"><code><strong><a href="../../org/scannotation/ClasspathUrlFinder.html#findResourceBases(java.lang.String,%20java.lang.ClassLoader)">findResourceBases</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseResource,
184 <a href="http://java.sun.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code>
185 <div class="block">Find the classpath URLs for a specific classpath resource.</div>
189 <ul class="blockList">
190 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
193 <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
194 <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
201 <div class="details">
202 <ul class="blockList">
203 <li class="blockList">
204 <!-- ========= CONSTRUCTOR DETAIL ======== -->
205 <ul class="blockList">
206 <li class="blockList"><a name="constructor_detail">
209 <h3>Constructor Detail</h3>
210 <a name="ClasspathUrlFinder()">
213 <ul class="blockListLast">
214 <li class="blockList">
215 <h4>ClasspathUrlFinder</h4>
216 <pre>public ClasspathUrlFinder()</pre>
221 <!-- ============ METHOD DETAIL ========== -->
222 <ul class="blockList">
223 <li class="blockList"><a name="method_detail">
226 <h3>Method Detail</h3>
227 <a name="findResourceBases(java.lang.String, java.lang.ClassLoader)">
230 <ul class="blockList">
231 <li class="blockList">
232 <h4>findResourceBases</h4>
233 <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>[] findResourceBases(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseResource,
234 <a href="http://java.sun.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</pre>
235 <div class="block">Find the classpath URLs for a specific classpath resource. The classpath URL is extracted
236 from loader.getResources() using the baseResource.</div>
237 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>baseResource</code> - </dd>
238 <dt><span class="strong">Returns:</span></dt><dd></dd></dl>
241 <a name="findResourceBases(java.lang.String)">
244 <ul class="blockList">
245 <li class="blockList">
246 <h4>findResourceBases</h4>
247 <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>[] findResourceBases(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseResource)</pre>
248 <div class="block">Find the classpath URLs for a specific classpath resource. The classpath URL is extracted
249 from loader.getResources() using the baseResource.</div>
250 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>baseResource</code> - </dd>
251 <dt><span class="strong">Returns:</span></dt><dd></dd></dl>
254 <a name="findResourceBase(java.lang.String)">
257 <ul class="blockList">
258 <li class="blockList">
259 <h4>findResourceBase</h4>
260 <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> findResourceBase(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseResource)</pre>
261 <div class="block">Find the classpath URL for a specific classpath resource. The classpath URL is extracted
262 from Thread.currentThread().getContextClassLoader().getResource() using the baseResource.</div>
263 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>baseResource</code> - </dd>
264 <dt><span class="strong">Returns:</span></dt><dd></dd></dl>
267 <a name="findResourceBase(java.lang.String, java.lang.ClassLoader)">
270 <ul class="blockList">
271 <li class="blockList">
272 <h4>findResourceBase</h4>
273 <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> findResourceBase(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseResource,
274 <a href="http://java.sun.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</pre>
275 <div class="block">Find the classpath URL for a specific classpath resource. The classpath URL is extracted
276 from loader.getResource() using the baseResource.</div>
277 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>baseResource</code> - </dd><dd><code>loader</code> - </dd>
278 <dt><span class="strong">Returns:</span></dt><dd></dd></dl>
281 <a name="findClassBase(java.lang.Class)">
284 <ul class="blockList">
285 <li class="blockList">
286 <h4>findClassBase</h4>
287 <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> findClassBase(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> clazz)</pre>
288 <div class="block">Find the classpath for the particular class</div>
289 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clazz</code> - </dd>
290 <dt><span class="strong">Returns:</span></dt><dd></dd></dl>
293 <a name="findClassPaths()">
296 <ul class="blockList">
297 <li class="blockList">
298 <h4>findClassPaths</h4>
299 <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>[] findClassPaths()</pre>
300 <div class="block">Uses the java.class.path system property to obtain a list of URLs that represent the CLASSPATH</div>
301 <dl><dt><span class="strong">Returns:</span></dt><dd></dd></dl>
304 <a name="findClassPaths(java.lang.String...)">
307 <ul class="blockListLast">
308 <li class="blockList">
309 <h4>findClassPaths</h4>
310 <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>[] findClassPaths(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... paths)</pre>
311 <div class="block">Uses the java.class.path system property to obtain a list of URLs that represent the CLASSPATH
313 paths is used as a filter to only include paths that have the specific relative file within it</div>
314 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>paths</code> - comma list of files that should exist in a particular path</dd>
315 <dt><span class="strong">Returns:</span></dt><dd></dd></dl>
324 <!-- ========= END OF CLASS DATA ========= -->
325 <!-- ======= START OF BOTTOM NAVBAR ====== -->
326 <div class="bottomNav"><a name="navbar_bottom">
328 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
331 <ul class="navList" title="Navigation">
332 <li><a href="../../overview-summary.html">Overview</a></li>
333 <li><a href="package-summary.html">Package</a></li>
334 <li class="navBarCell1Rev">Class</li>
335 <li><a href="class-use/ClasspathUrlFinder.html">Use</a></li>
336 <li><a href="package-tree.html">Tree</a></li>
337 <li><a href="../../deprecated-list.html">Deprecated</a></li>
338 <li><a href="../../index-all.html">Index</a></li>
339 <li><a href="../../help-doc.html">Help</a></li>
344 <li><a href="../../org/scannotation/AnnotationDB.CrossReferenceException.html" title="class in org.scannotation"><span class="strong">Prev Class</span></a></li>
345 <li><a href="../../org/scannotation/WarUrlFinder.html" title="class in org.scannotation"><span class="strong">Next Class</span></a></li>
348 <li><a href="../../index.html?org/scannotation/ClasspathUrlFinder.html" target="_top">Frames</a></li>
349 <li><a href="ClasspathUrlFinder.html" target="_top">No Frames</a></li>
351 <ul class="navList" id="allclasses_navbar_bottom">
352 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
355 <script type="text/javascript"><!--
356 allClassesLink = document.getElementById("allclasses_navbar_bottom");
358 allClassesLink.style.display = "block";
361 allClassesLink.style.display = "none";
367 <ul class="subNavList">
368 <li>Summary: </li>
369 <li>Nested | </li>
370 <li>Field | </li>
371 <li><a href="#constructor_summary">Constr</a> | </li>
372 <li><a href="#method_summary">Method</a></li>
374 <ul class="subNavList">
375 <li>Detail: </li>
376 <li>Field | </li>
377 <li><a href="#constructor_detail">Constr</a> | </li>
378 <li><a href="#method_detail">Method</a></li>
381 <a name="skip-navbar_bottom">
384 <!-- ======== END OF BOTTOM NAVBAR ======= -->
385 <p class="legalCopy"><small>Copyright © 2015. All Rights Reserved.</small></p>