You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ClassPath.html 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11) on Sat May 08 11:16:00 JST 2021 -->
  6. <title>ClassPath (Javassist API)</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2021-05-08">
  9. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.css" title="Style">
  11. <script type="text/javascript" src="../script.js"></script>
  12. <script type="text/javascript" src="../jquery/jszip/dist/jszip.min.js"></script>
  13. <script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  14. <!--[if IE]>
  15. <script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  16. <![endif]-->
  17. <script type="text/javascript" src="../jquery/jquery-3.3.1.js"></script>
  18. <script type="text/javascript" src="../jquery/jquery-migrate-3.0.1.js"></script>
  19. <script type="text/javascript" src="../jquery/jquery-ui.js"></script>
  20. </head>
  21. <body>
  22. <script type="text/javascript"><!--
  23. try {
  24. if (location.href.indexOf('is-external=true') == -1) {
  25. parent.document.title="ClassPath (Javassist API)";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":6,"i1":6};
  32. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  33. var altColor = "altColor";
  34. var rowColor = "rowColor";
  35. var tableTab = "tableTab";
  36. var activeTableTab = "activeTableTab";
  37. var pathtoroot = "../";
  38. var useModuleDirectories = true;
  39. loadScripts(document, 'script');</script>
  40. <noscript>
  41. <div>JavaScript is disabled on your browser.</div>
  42. </noscript>
  43. <header role="banner">
  44. <nav role="navigation">
  45. <div class="fixedNav">
  46. <!-- ========= START OF TOP NAVBAR ======= -->
  47. <div class="topNav"><a id="navbar.top">
  48. <!-- -->
  49. </a>
  50. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  51. <a id="navbar.top.firstrow">
  52. <!-- -->
  53. </a>
  54. <ul class="navList" title="Navigation">
  55. <li><a href="../index.html">Overview</a></li>
  56. <li><a href="package-summary.html">Package</a></li>
  57. <li class="navBarCell1Rev">Class</li>
  58. <li><a href="class-use/ClassPath.html">Use</a></li>
  59. <li><a href="package-tree.html">Tree</a></li>
  60. <li><a href="../deprecated-list.html">Deprecated</a></li>
  61. <li><a href="../index-all.html">Index</a></li>
  62. </ul>
  63. </div>
  64. <div class="subNav">
  65. <ul class="navList" id="allclasses_navbar_top">
  66. <li><a href="../allclasses.html">All&nbsp;Classes</a></li>
  67. </ul>
  68. <ul class="navListSearch">
  69. <li><label for="search">SEARCH:</label>
  70. <input type="text" id="search" value="search" disabled="disabled">
  71. <input type="reset" id="reset" value="reset" disabled="disabled">
  72. </li>
  73. </ul>
  74. <div>
  75. <script type="text/javascript"><!--
  76. allClassesLink = document.getElementById("allclasses_navbar_top");
  77. if(window==top) {
  78. allClassesLink.style.display = "block";
  79. }
  80. else {
  81. allClassesLink.style.display = "none";
  82. }
  83. //-->
  84. </script>
  85. <noscript>
  86. <div>JavaScript is disabled on your browser.</div>
  87. </noscript>
  88. </div>
  89. <div>
  90. <ul class="subNavList">
  91. <li>Summary:&nbsp;</li>
  92. <li>Nested&nbsp;|&nbsp;</li>
  93. <li>Field&nbsp;|&nbsp;</li>
  94. <li>Constr&nbsp;|&nbsp;</li>
  95. <li><a href="#method.summary">Method</a></li>
  96. </ul>
  97. <ul class="subNavList">
  98. <li>Detail:&nbsp;</li>
  99. <li>Field&nbsp;|&nbsp;</li>
  100. <li>Constr&nbsp;|&nbsp;</li>
  101. <li><a href="#method.detail">Method</a></li>
  102. </ul>
  103. </div>
  104. <a id="skip.navbar.top">
  105. <!-- -->
  106. </a></div>
  107. <!-- ========= END OF TOP NAVBAR ========= -->
  108. </div>
  109. <div class="navPadding">&nbsp;</div>
  110. <script type="text/javascript"><!--
  111. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  112. //-->
  113. </script>
  114. </nav>
  115. </header>
  116. <!-- ======== START OF CLASS DATA ======== -->
  117. <main role="main">
  118. <div class="header">
  119. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">javassist</a></div>
  120. <h2 title="Interface ClassPath" class="title">Interface ClassPath</h2>
  121. </div>
  122. <div class="contentContainer">
  123. <div class="description">
  124. <ul class="blockList">
  125. <li class="blockList">
  126. <dl>
  127. <dt>All Known Implementing Classes:</dt>
  128. <dd><code><a href="ByteArrayClassPath.html" title="class in javassist">ByteArrayClassPath</a></code>, <code><a href="ClassClassPath.html" title="class in javassist">ClassClassPath</a></code>, <code><a href="LoaderClassPath.html" title="class in javassist">LoaderClassPath</a></code>, <code><a href="URLClassPath.html" title="class in javassist">URLClassPath</a></code></dd>
  129. </dl>
  130. <hr>
  131. <pre>public interface <span class="typeNameLabel">ClassPath</span></pre>
  132. <div class="block"><code>ClassPath</code> is an interface implemented by objects
  133. representing a class search path.
  134. <code>ClassPool</code> uses those objects for reading class files.
  135. <p>The users can define a class implementing this interface so that
  136. a class file is obtained from a non-standard source.</div>
  137. <dl>
  138. <dt><span class="seeLabel">See Also:</span></dt>
  139. <dd><a href="ClassPool.html#insertClassPath(javassist.ClassPath)"><code>ClassPool.insertClassPath(ClassPath)</code></a>,
  140. <a href="ClassPool.html#appendClassPath(javassist.ClassPath)"><code>ClassPool.appendClassPath(ClassPath)</code></a>,
  141. <a href="ClassPool.html#removeClassPath(javassist.ClassPath)"><code>ClassPool.removeClassPath(ClassPath)</code></a></dd>
  142. </dl>
  143. </li>
  144. </ul>
  145. </div>
  146. <div class="summary">
  147. <ul class="blockList">
  148. <li class="blockList">
  149. <!-- ========== METHOD SUMMARY =========== -->
  150. <section role="region">
  151. <ul class="blockList">
  152. <li class="blockList"><a id="method.summary">
  153. <!-- -->
  154. </a>
  155. <h3>Method Summary</h3>
  156. <table class="memberSummary">
  157. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  158. <tr>
  159. <th class="colFirst" scope="col">Modifier and Type</th>
  160. <th class="colSecond" scope="col">Method</th>
  161. <th class="colLast" scope="col">Description</th>
  162. </tr>
  163. <tr id="i0" class="altColor">
  164. <td class="colFirst"><code>java.net.URL</code></td>
  165. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#find(java.lang.String)">find</a></span>&#8203;(java.lang.String&nbsp;classname)</code></th>
  166. <td class="colLast">
  167. <div class="block">Returns the uniform resource locator (URL) of the class file
  168. with the specified name.</div>
  169. </td>
  170. </tr>
  171. <tr id="i1" class="rowColor">
  172. <td class="colFirst"><code>java.io.InputStream</code></td>
  173. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openClassfile(java.lang.String)">openClassfile</a></span>&#8203;(java.lang.String&nbsp;classname)</code></th>
  174. <td class="colLast">
  175. <div class="block">Opens a class file.</div>
  176. </td>
  177. </tr>
  178. </table>
  179. </li>
  180. </ul>
  181. </section>
  182. </li>
  183. </ul>
  184. </div>
  185. <div class="details">
  186. <ul class="blockList">
  187. <li class="blockList">
  188. <!-- ============ METHOD DETAIL ========== -->
  189. <section role="region">
  190. <ul class="blockList">
  191. <li class="blockList"><a id="method.detail">
  192. <!-- -->
  193. </a>
  194. <h3>Method Detail</h3>
  195. <a id="openClassfile(java.lang.String)">
  196. <!-- -->
  197. </a>
  198. <ul class="blockList">
  199. <li class="blockList">
  200. <h4>openClassfile</h4>
  201. <pre class="methodSignature">java.io.InputStream&nbsp;openClassfile&#8203;(java.lang.String&nbsp;classname)
  202. throws <a href="NotFoundException.html" title="class in javassist">NotFoundException</a></pre>
  203. <div class="block">Opens a class file.
  204. This method may be called just to examine whether the class file
  205. exists as well as to read the contents of the file.
  206. <p>This method can return null if the specified class file is not
  207. found. If null is returned, the next search path is examined.
  208. However, if an error happens, this method must throw an exception
  209. so that the search will be terminated.
  210. <p>This method should not modify the contents of the class file.</div>
  211. <dl>
  212. <dt><span class="paramLabel">Parameters:</span></dt>
  213. <dd><code>classname</code> - a fully-qualified class name</dd>
  214. <dt><span class="returnLabel">Returns:</span></dt>
  215. <dd>the input stream for reading a class file</dd>
  216. <dt><span class="throwsLabel">Throws:</span></dt>
  217. <dd><code><a href="NotFoundException.html" title="class in javassist">NotFoundException</a></code></dd>
  218. <dt><span class="seeLabel">See Also:</span></dt>
  219. <dd><a href="Translator.html" title="interface in javassist"><code>Translator</code></a></dd>
  220. </dl>
  221. </li>
  222. </ul>
  223. <a id="find(java.lang.String)">
  224. <!-- -->
  225. </a>
  226. <ul class="blockListLast">
  227. <li class="blockList">
  228. <h4>find</h4>
  229. <pre class="methodSignature">java.net.URL&nbsp;find&#8203;(java.lang.String&nbsp;classname)</pre>
  230. <div class="block">Returns the uniform resource locator (URL) of the class file
  231. with the specified name.</div>
  232. <dl>
  233. <dt><span class="paramLabel">Parameters:</span></dt>
  234. <dd><code>classname</code> - a fully-qualified class name.</dd>
  235. <dt><span class="returnLabel">Returns:</span></dt>
  236. <dd>null if the specified class file could not be found.</dd>
  237. </dl>
  238. </li>
  239. </ul>
  240. </li>
  241. </ul>
  242. </section>
  243. </li>
  244. </ul>
  245. </div>
  246. </div>
  247. </main>
  248. <!-- ========= END OF CLASS DATA ========= -->
  249. <footer role="contentinfo">
  250. <nav role="navigation">
  251. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  252. <div class="bottomNav"><a id="navbar.bottom">
  253. <!-- -->
  254. </a>
  255. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  256. <a id="navbar.bottom.firstrow">
  257. <!-- -->
  258. </a>
  259. <ul class="navList" title="Navigation">
  260. <li><a href="../index.html">Overview</a></li>
  261. <li><a href="package-summary.html">Package</a></li>
  262. <li class="navBarCell1Rev">Class</li>
  263. <li><a href="class-use/ClassPath.html">Use</a></li>
  264. <li><a href="package-tree.html">Tree</a></li>
  265. <li><a href="../deprecated-list.html">Deprecated</a></li>
  266. <li><a href="../index-all.html">Index</a></li>
  267. </ul>
  268. </div>
  269. <div class="subNav">
  270. <ul class="navList" id="allclasses_navbar_bottom">
  271. <li><a href="../allclasses.html">All&nbsp;Classes</a></li>
  272. </ul>
  273. <div>
  274. <script type="text/javascript"><!--
  275. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  276. if(window==top) {
  277. allClassesLink.style.display = "block";
  278. }
  279. else {
  280. allClassesLink.style.display = "none";
  281. }
  282. //-->
  283. </script>
  284. <noscript>
  285. <div>JavaScript is disabled on your browser.</div>
  286. </noscript>
  287. </div>
  288. <div>
  289. <ul class="subNavList">
  290. <li>Summary:&nbsp;</li>
  291. <li>Nested&nbsp;|&nbsp;</li>
  292. <li>Field&nbsp;|&nbsp;</li>
  293. <li>Constr&nbsp;|&nbsp;</li>
  294. <li><a href="#method.summary">Method</a></li>
  295. </ul>
  296. <ul class="subNavList">
  297. <li>Detail:&nbsp;</li>
  298. <li>Field&nbsp;|&nbsp;</li>
  299. <li>Constr&nbsp;|&nbsp;</li>
  300. <li><a href="#method.detail">Method</a></li>
  301. </ul>
  302. </div>
  303. <a id="skip.navbar.bottom">
  304. <!-- -->
  305. </a></div>
  306. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  307. </nav>
  308. <p class="legalCopy"><small><i>Javassist, a Java-bytecode translator toolkit.<br>
  309. Copyright (C) 1999- Shigeru Chiba. All Rights Reserved.</i></small></p>
  310. </footer>
  311. </body>
  312. </html>