| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>SharedClassHelperFactory (OpenJ9 JDK 16)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: openj9.sharedclasses, package: com.ibm.oti.shared, interface: SharedClassHelperFactory"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.oti.shared.SharedClassHelperFactory interface"> |
| <meta name="keywords" content="getTokenHelper()"> |
| <meta name="keywords" content="getURLHelper()"> |
| <meta name="keywords" content="getURLClasspathHelper()"> |
| <meta name="keywords" content="findHelperForClassLoader()"> |
| <meta name="keywords" content="findHelpersForClassLoader()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/SharedClassHelperFactory.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../module-summary.html">openj9.sharedclasses</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.oti.shared</a></div> |
| <h1 title="Interface SharedClassHelperFactory" class="title">Interface SharedClassHelperFactory</h1> |
| </div> |
| <section class="description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SharedClassHelperFactory</span></div> |
| <div class="block"><p>SharedClassHelperFactory provides an interface that is |
| used to create various types of SharedClassHelper for ClassLoaders.</p> |
| |
| <p>ClassLoaders and each type of SharedClassHelpers have a one-to-one relationship.</p> |
| |
| There are 3 different types of SharedClassHelper:<br> |
| <ol> |
| <li>SharedClassTokenHelper<br> |
| Stores and finds classes using a String token generated by the ClassLoader. |
| For use by ClassLoaders that require complete control over cache contents.</li> |
| |
| <li>SharedClassURLHelper<br> |
| Stores and finds classes using a URL location. Any URL can be used to store or find classes.<br> |
| For use by ClassLoaders that do not have the concept of a classpath, which load classes from multiple locations.<br> |
| Classes can only be stored using jar/zip or file URLs. Classes are automatically kept up-to-date by the cache.<br> |
| Classes stored using SharedClassURLClasspathHelper can be found by using this helper, and vice versa.</li> |
| |
| <li>SharedClassURLClasspathHelper<br> |
| Stores and finds classes using a URL classpath. URLs can be appended to the classpath at any time. |
| The classpath can also be modified under certain circumstances (see SharedClassURLClasspathHelper javadoc).<br> |
| For use by ClassLoaders that load classes by using a URL classpath.<br> |
| Classes can only be stored using jar/zip or file URLs. Classes are automatically kept up-to-date by the cache.<br> |
| Classes stored using SharedClassURLHelper can be found using this helper, and vice versa.</li> |
| </ol></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassTokenHelper</code></a>, |
| <a href="SharedClassURLHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLHelper</code></a>, |
| <a href="SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLClasspathHelper</code></a></dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table method-summary-table-tab3"><code><a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#findHelperForClassLoader(java.lang.ClassLoader)">findHelperForClassLoader</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table method-summary-table-tab3"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use findHelpersForClassLoader(ClassLoader loader) instead.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link" target="_blank">Set</a><<a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#findHelpersForClassLoader(java.lang.ClassLoader)">findHelpersForClassLoader</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Utility function that returns a set of SharedClassHelper for a given ClassLoader.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getTokenHelper(java.lang.ClassLoader)">getTokenHelper</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Returns a SharedClassTokenHelper for a given ClassLoader.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getTokenHelper(java.lang.ClassLoader,com.ibm.oti.shared.SharedClassFilter)">getTokenHelper</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader, |
| <a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Returns a SharedClassTokenHelper for a given ClassLoader.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getURLClasspathHelper(java.lang.ClassLoader,java.net.URL%5B%5D)">getURLClasspathHelper</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URL.html" title="class or interface in java.net" class="external-link" target="_blank">URL</a>[] classpath)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Returns a SharedClassURLClasspathHelper for a given ClassLoader.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getURLClasspathHelper(java.lang.ClassLoader,java.net.URL%5B%5D,com.ibm.oti.shared.SharedClassFilter)">getURLClasspathHelper</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URL.html" title="class or interface in java.net" class="external-link" target="_blank">URL</a>[] classpath, |
| <a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Returns a SharedClassURLClasspathHelper for a given ClassLoader.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getURLHelper(java.lang.ClassLoader)">getURLHelper</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Returns a SharedClassURLHelper for a given ClassLoader.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getURLHelper(java.lang.ClassLoader,com.ibm.oti.shared.SharedClassFilter)">getURLHelper</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader, |
| <a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Returns a SharedClassURLHelper for a given ClassLoader.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getTokenHelper(java.lang.ClassLoader)"> |
| <h3>getTokenHelper</h3> |
| <div class="member-signature"><span class="return-type"><a href="SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a></span> <span class="element-name">getTokenHelper</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader)</span></div> |
| <div class="block"><p>Returns a SharedClassTokenHelper for a given ClassLoader.</p> |
| <p>Creates a new SharedClassTokenHelper if one cannot be found, otherwise returns an existing SharedClassTokenHelper.</p> |
| <p>Throws a HelperAlreadyDefinedException if the ClassLoader already has a different type of helper.</p> |
| <p>Returns null if a SecurityManager is installed and there is no |
| SharedClassPermission for the ClassLoader specified.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - ClassLoader. |
| ClassLoader to which this SharedClassTokenHelper will belong</dd> |
| <dt>Returns:</dt> |
| <dd>SharedClassTokenHelper. |
| A new or existing SharedClassTokenHelper</dd> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassTokenHelper</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTokenHelper(java.lang.ClassLoader,com.ibm.oti.shared.SharedClassFilter)"> |
| <h3>getTokenHelper</h3> |
| <div class="member-signature"><span class="return-type"><a href="SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a></span> <span class="element-name">getTokenHelper</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader, |
| <a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a> filter)</span></div> |
| <div class="block"><p>Returns a SharedClassTokenHelper for a given ClassLoader.</p> |
| <p>Creates a new SharedClassTokenHelper if one cannot be found, otherwise returns existing SharedClassTokenHelper.</p> |
| <p>Throws a HelperAlreadyDefinedException if the ClassLoader already has a different type of helper.</p> |
| <p>Returns null if a SecurityManager is installed and there is no |
| SharedClassPermission for the ClassLoader specified.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - ClassLoader. |
| ClassLoader to which this SharedClassTokenHelper will belong</dd> |
| <dd><code>filter</code> - SharedClassURLFilter. |
| Specify a filter which limits the classes that are found or stored in the cache</dd> |
| <dt>Returns:</dt> |
| <dd>SharedClassTokenHelper. |
| A new or existing SharedClassTokenHelper</dd> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassTokenHelper</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getURLHelper(java.lang.ClassLoader)"> |
| <h3>getURLHelper</h3> |
| <div class="member-signature"><span class="return-type"><a href="SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a></span> <span class="element-name">getURLHelper</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader)</span></div> |
| <div class="block"><p>Returns a SharedClassURLHelper for a given ClassLoader.</p> |
| <p>Creates a new SharedClassURLHelper if one cannot be found, otherwise returns existing SharedClassURLHelper.</p> |
| <p>Throws a HelperAlreadyDefinedException if the ClassLoader already has a different type of helper.</p> |
| <p>Returns null if a SecurityManager is installed and there is no |
| SharedClassPermission for the ClassLoader specified.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - ClassLoader. |
| ClassLoader to which this SharedClassURLHelper will belong</dd> |
| <dt>Returns:</dt> |
| <dd>SharedClassURLHelper. |
| A new or existing SharedClassURLHelper</dd> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassURLHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLHelper</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getURLClasspathHelper(java.lang.ClassLoader,java.net.URL[])"> |
| <h3>getURLClasspathHelper</h3> |
| <div class="member-signature"><span class="return-type"><a href="SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a></span> <span class="element-name">getURLClasspathHelper</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URL.html" title="class or interface in java.net" class="external-link" target="_blank">URL</a>[] classpath)</span> |
| throws <span class="exceptions"><a href="HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></span></div> |
| <div class="block"><p>Returns a SharedClassURLClasspathHelper for a given ClassLoader.</p> |
| <p>Creates a new SharedClassURLClasspathHelper if one cannot be found, |
| otherwise if the classpath specified matches the classpath of an existing helper, returns existing SharedClassURLClasspathHelper.</p> |
| <p>Throws a HelperAlreadyDefinedException if the ClassLoader already has a different type of helper, or |
| if the ClassLoader has a SharedClassURLClasspathHelper with a different classpath.</p> |
| <p>Returns null if a SecurityManager is installed and there is no |
| SharedClassPermission for the ClassLoader specified.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - ClassLoader. |
| ClassLoader to which this SharedClassURLClasspathHelper will belong</dd> |
| <dd><code>classpath</code> - URL[]. |
| The current URL classpath of this ClassLoader</dd> |
| <dt>Returns:</dt> |
| <dd>SharedClassURLClasspathHelper. |
| A new or existing SharedClassURLClasspathHelper</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></code> - when another SharedClassURLClasspathHelper has been already defined for this class loader</dd> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLClasspathHelper</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getURLClasspathHelper(java.lang.ClassLoader,java.net.URL[],com.ibm.oti.shared.SharedClassFilter)"> |
| <h3>getURLClasspathHelper</h3> |
| <div class="member-signature"><span class="return-type"><a href="SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a></span> <span class="element-name">getURLClasspathHelper</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/net/URL.html" title="class or interface in java.net" class="external-link" target="_blank">URL</a>[] classpath, |
| <a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a> filter)</span> |
| throws <span class="exceptions"><a href="HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></span></div> |
| <div class="block"><p>Returns a SharedClassURLClasspathHelper for a given ClassLoader.</p> |
| <p>Creates a new SharedClassURLClasspathHelper if one cannot be found, |
| otherwise if the classpath specified matches the classpath of an existing helper, returns existing SharedClassURLClasspathHelper.</p> |
| <p>If a new SharedClassHelper is created, the specified SharedClassURLFilter is applied to it. If the filter argument is null, no filter is applied.</p> |
| <p>Throws a HelperAlreadyDefinedException if the ClassLoader already has a different type of helper OR |
| if the ClassLoader has a SharedClassURLClasspathHelper with a different classpath.</p> |
| <p>Returns null if a SecurityManager is installed and there is no |
| SharedClassPermission for the ClassLoader specified.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - ClassLoader. |
| ClassLoader to which this SharedClassURLClasspathHelper will belong</dd> |
| <dd><code>classpath</code> - URL[]. |
| The current URL classpath of this ClassLoader</dd> |
| <dd><code>filter</code> - SharedClassURLFilter. |
| Specify a filter which limits the classes that are found or stored in the cache</dd> |
| <dt>Returns:</dt> |
| <dd>SharedClassURLClasspathHelper. |
| A new or existing SharedClassURLClasspathHelper</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></code> - when another SharedClassURLClasspathHelper has been already defined for this class loader</dd> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLClasspathHelper</code></a>, |
| <a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared"><code>SharedClassFilter</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getURLHelper(java.lang.ClassLoader,com.ibm.oti.shared.SharedClassFilter)"> |
| <h3>getURLHelper</h3> |
| <div class="member-signature"><span class="return-type"><a href="SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a></span> <span class="element-name">getURLHelper</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader, |
| <a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a> filter)</span></div> |
| <div class="block"><p>Returns a SharedClassURLHelper for a given ClassLoader.</p> |
| <p>Creates a new SharedClassURLHelper if one cannot be found, otherwise returns existing SharedClassURLHelper.</p> |
| <p>If a new SharedClassHelper is created, the specified SharedClassURLFilter is applied to it. If the filter argument is null, no filter is applied.</p> |
| <p>Throws a HelperAlreadyDefinedException if the ClassLoader already has a different type of helper.</p> |
| <p>Returns null if a SecurityManager is installed and there is no |
| SharedClassPermission for the ClassLoader specified.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - ClassLoader. |
| ClassLoader to which this SharedClassURLHelper will belong</dd> |
| <dd><code>filter</code> - SharedClassURLFilter. |
| Specify a filter which limits the classes that are found or stored in the cache</dd> |
| <dt>Returns:</dt> |
| <dd>SharedClassURLHelper. |
| A new or existing SharedClassURLHelper</dd> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassURLHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLHelper</code></a>, |
| <a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared"><code>SharedClassFilter</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findHelperForClassLoader(java.lang.ClassLoader)"> |
| <h3>findHelperForClassLoader</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link" target="_blank">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Deprecated.html#forRemoval()" title="class or interface in java.lang" class="external-link" target="_blank">forRemoval</a>=false, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link" target="_blank">since</a>="9") |
| </span><span class="return-type"><a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a></span> <span class="element-name">findHelperForClassLoader</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use findHelpersForClassLoader(ClassLoader loader) instead.</div> |
| </div> |
| <div class="block"><p>Utility function that returns a SharedClassHelper for a given ClassLoader.</p> |
| <p>Can be used to determine whether a given ClassLoader already has a helper, before calling a getter method.</p> |
| <p>Returns an existing SharedClassHelper or null.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - ClassLoader. |
| ClassLoader which may or may not have a SharedClassHelper</dd> |
| <dt>Returns:</dt> |
| <dd>SharedClassHelper. |
| A helper if one exists for this ClassLoader or null otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalStateException</a></code> - If this ClassLoader has more than one helper.</dd> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassHelper</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findHelpersForClassLoader(java.lang.ClassLoader)"> |
| <h3>findHelpersForClassLoader</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link" target="_blank">Set</a><<a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a>></span> <span class="element-name">findHelpersForClassLoader</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link" target="_blank">ClassLoader</a> loader)</span></div> |
| <div class="block"><p>Utility function that returns a set of SharedClassHelper for a given ClassLoader.</p> |
| <p>Can be used to determine whether a given ClassLoader already has a specific helper, before calling a getter method.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>loader</code> - ClassLoader. |
| ClassLoader which may or may not have a SharedClassHelper</dd> |
| <dt>Returns:</dt> |
| <dd>Set<SharedClassHelper>. |
| A set of helpers exist for this ClassLoader.</dd> |
| <dt>See Also:</dt> |
| <dd><a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassHelper</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
