blob: 9400cfe4bb83da34c76a58089cdb9c01417a7eab [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SharedClassHelperFactory (OpenJ9 Shared Classes)</title>
<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()">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SharedClassHelperFactory (OpenJ9 Shared Classes)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/ibm/oti/shared/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 Shared Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ibm/oti/shared/SharedClassHelper.html" title="interface in com.ibm.oti.shared"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/oti/shared/SharedClassPermission.html" title="class in com.ibm.oti.shared"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ibm/oti/shared/SharedClassHelperFactory.html" target="_top">Frames</a></li>
<li><a href="SharedClassHelperFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.ibm.oti.shared</div>
<h2 title="Interface SharedClassHelperFactory" class="title">Interface SharedClassHelperFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SharedClassHelperFactory</span></pre>
<div class="block"><p>SharedClassHelperFactory provides an interface that is
used to create various types of SharedClassHelper for ClassLoaders.</p>
<p>ClassLoaders and SharedClassHelpers have a one-to-one relationship.
Any attempts to get a helper for a ClassLoader that already has a different type of helper
will result in a HelperAlreadyDefinedException.</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassTokenHelper</code></a>,
<a href="../../../../com/ibm/oti/shared/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLHelper</code></a>,
<a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLClasspathHelper</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../com/ibm/oti/shared/SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassHelperFactory.html#findHelperForClassLoader-java.lang.ClassLoader-">findHelperForClassLoader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</code>
<div class="block">Utility function that returns a SharedClassHelper for a given ClassLoader.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/ibm/oti/shared/SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassHelperFactory.html#getTokenHelper-java.lang.ClassLoader-">getTokenHelper</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</code>
<div class="block">Returns a SharedClassTokenHelper for a given ClassLoader.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../com/ibm/oti/shared/SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassHelperFactory.html#getTokenHelper-java.lang.ClassLoader-com.ibm.oti.shared.SharedClassFilter-">getTokenHelper</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader,
<a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a>&nbsp;filter)</code>
<div class="block">Returns a SharedClassTokenHelper for a given ClassLoader.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassHelperFactory.html#getURLClasspathHelper-java.lang.ClassLoader-java.net.URL:A-">getURLClasspathHelper</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" target="_blank" title="class or interface in java.net">URL</a>[]&nbsp;classpath)</code>
<div class="block">Returns a SharedClassURLClasspathHelper for a given ClassLoader.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassHelperFactory.html#getURLClasspathHelper-java.lang.ClassLoader-java.net.URL:A-com.ibm.oti.shared.SharedClassFilter-">getURLClasspathHelper</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" target="_blank" title="class or interface in java.net">URL</a>[]&nbsp;classpath,
<a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a>&nbsp;filter)</code>
<div class="block">Returns a SharedClassURLClasspathHelper for a given ClassLoader.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/ibm/oti/shared/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassHelperFactory.html#getURLHelper-java.lang.ClassLoader-">getURLHelper</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</code>
<div class="block">Returns a SharedClassURLHelper for a given ClassLoader.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../com/ibm/oti/shared/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassHelperFactory.html#getURLHelper-java.lang.ClassLoader-com.ibm.oti.shared.SharedClassFilter-">getURLHelper</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader,
<a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a>&nbsp;filter)</code>
<div class="block">Returns a SharedClassURLHelper for a given ClassLoader.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTokenHelper-java.lang.ClassLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTokenHelper</h4>
<pre><a href="../../../../com/ibm/oti/shared/SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a>&nbsp;getTokenHelper(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)
throws <a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></pre>
<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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loader</code> - ClassLoader.
ClassLoader to which this SharedClassTokenHelper will belong</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SharedClassTokenHelper.
A new or existing SharedClassTokenHelper</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></code> - when another helper has been already defined for this class loader.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassTokenHelper</code></a></dd>
</dl>
</li>
</ul>
<a name="getTokenHelper-java.lang.ClassLoader-com.ibm.oti.shared.SharedClassFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTokenHelper</h4>
<pre><a href="../../../../com/ibm/oti/shared/SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a>&nbsp;getTokenHelper(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader,
<a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a>&nbsp;filter)
throws <a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></pre>
<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>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>SharedClassTokenHelper.
A new or existing SharedClassTokenHelper</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></code> - when another helper has been already defined for this class loader</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassTokenHelper</code></a></dd>
</dl>
</li>
</ul>
<a name="getURLHelper-java.lang.ClassLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURLHelper</h4>
<pre><a href="../../../../com/ibm/oti/shared/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a>&nbsp;getURLHelper(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)
throws <a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></pre>
<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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loader</code> - ClassLoader.
ClassLoader to which this SharedClassURLHelper will belong</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SharedClassURLHelper.
A new or existing SharedClassURLHelper</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></code> - when another helper has been already defined for this class loader</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLHelper</code></a></dd>
</dl>
</li>
</ul>
<a name="getURLClasspathHelper-java.lang.ClassLoader-java.net.URL:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURLClasspathHelper</h4>
<pre><a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a>&nbsp;getURLClasspathHelper(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" target="_blank" title="class or interface in java.net">URL</a>[]&nbsp;classpath)
throws <a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></pre>
<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>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>SharedClassURLClasspathHelper.
A new or existing SharedClassURLClasspathHelper</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></code> - when another helper has been already defined for this class loader</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLClasspathHelper</code></a></dd>
</dl>
</li>
</ul>
<a name="getURLClasspathHelper-java.lang.ClassLoader-java.net.URL:A-com.ibm.oti.shared.SharedClassFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURLClasspathHelper</h4>
<pre><a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a>&nbsp;getURLClasspathHelper(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" target="_blank" title="class or interface in java.net">URL</a>[]&nbsp;classpath,
<a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a>&nbsp;filter)
throws <a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></pre>
<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>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>SharedClassURLClasspathHelper.
A new or existing SharedClassURLClasspathHelper</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></code> - when another helper has been already defined for this class loader</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLClasspathHelper</code></a>,
<a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared"><code>SharedClassFilter</code></a></dd>
</dl>
</li>
</ul>
<a name="getURLHelper-java.lang.ClassLoader-com.ibm.oti.shared.SharedClassFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURLHelper</h4>
<pre><a href="../../../../com/ibm/oti/shared/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a>&nbsp;getURLHelper(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader,
<a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a>&nbsp;filter)
throws <a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></pre>
<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>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>SharedClassURLHelper.
A new or existing SharedClassURLHelper</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/ibm/oti/shared/HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></code> - when another helper has been already defined for this class loader</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassURLHelper</code></a>,
<a href="../../../../com/ibm/oti/shared/SharedClassFilter.html" title="interface in com.ibm.oti.shared"><code>SharedClassFilter</code></a></dd>
</dl>
</li>
</ul>
<a name="findHelperForClassLoader-java.lang.ClassLoader-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>findHelperForClassLoader</h4>
<pre><a href="../../../../com/ibm/oti/shared/SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a>&nbsp;findHelperForClassLoader(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" target="_blank" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</pre>
<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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loader</code> - ClassLoader.
ClassLoader which may or may not have a SharedClassHelper</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SharedClassHelper.
A helper if one exists for this ClassLoader or null otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassHelper.html" title="interface in com.ibm.oti.shared"><code>SharedClassHelper</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/ibm/oti/shared/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 Shared Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ibm/oti/shared/SharedClassHelper.html" title="interface in com.ibm.oti.shared"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/oti/shared/SharedClassPermission.html" title="class in com.ibm.oti.shared"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ibm/oti/shared/SharedClassHelperFactory.html" target="_top">Frames</a></li>
<li><a href="SharedClassHelperFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</body>
</html>