blob: 73c64d8f257fd24b5756e83cbda49a5044b28d24 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>com.ibm.oti.shared (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<meta name="keywords" content="com.ibm.oti.shared package">
<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="package-declaration-page">
<script type="text/javascript">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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.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 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">
<div class="header">
<div class="sub-title"><span class="module-label-in-package">Module</span>&nbsp;<a href="../../../../module-summary.html">openj9.sharedclasses</a></div>
<h1 title="Package" class="title">Package&nbsp;com.ibm.oti.shared</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">com.ibm.oti.shared</span></div>
<section class="package-description" id="package.description">
<div class="block">The OpenJ9 shared classes API, a persistent share which can contain classes, precompiled code (AOT),
JIT data, and other data used to improve start up performance and reduce memory footprint.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div class="caption"><span>Interface Summary</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="SharedClassFilter.html" title="interface in com.ibm.oti.shared">SharedClassFilter</a></div>
<div class="col-last even-row-color">
<div class="block">SharedClassFilter allows users of a Helper API to filter which classes are found and stored in the cache.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedClassHelper.html" title="interface in com.ibm.oti.shared">SharedClassHelper</a></div>
<div class="col-last odd-row-color">
<div class="block">The SharedClassHelper superinterface defines functions that are common
to all class helpers.</div>
</div>
<div class="col-first even-row-color"><a href="SharedClassHelperFactory.html" title="interface in com.ibm.oti.shared">SharedClassHelperFactory</a></div>
<div class="col-last even-row-color">
<div class="block">SharedClassHelperFactory provides an interface that is
used to create various types of SharedClassHelper for ClassLoaders.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedClassTokenHelper.html" title="interface in com.ibm.oti.shared">SharedClassTokenHelper</a></div>
<div class="col-last odd-row-color">
<div class="block">SharedClassHelper API that stores and finds classes using String tokens.</div>
</div>
<div class="col-first even-row-color"><a href="SharedClassURLClasspathHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper</a></div>
<div class="col-last even-row-color">
<div class="block">SharedClassHelper API that stores and finds classes by using URL classpaths.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedClassURLClasspathHelper.IndexHolder.html" title="interface in com.ibm.oti.shared">SharedClassURLClasspathHelper.IndexHolder</a></div>
<div class="col-last odd-row-color">
<div class="block">Interface that allows an index to be returned from findSharedClass calls.</div>
</div>
<div class="col-first even-row-color"><a href="SharedClassURLHelper.html" title="interface in com.ibm.oti.shared">SharedClassURLHelper</a></div>
<div class="col-last even-row-color">
<div class="block">SharedClassHelper API that stores and finds classes by using URL paths.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedDataHelper.html" title="interface in com.ibm.oti.shared">SharedDataHelper</a></div>
<div class="col-last odd-row-color">
<div class="block">SharedDataHelper API that stores and finds byte data using String tokens.</div>
</div>
<div class="col-first even-row-color"><a href="SharedDataHelperFactory.html" title="interface in com.ibm.oti.shared">SharedDataHelperFactory</a></div>
<div class="col-last even-row-color">
<div class="block">SharedDataHelperFactory provides an interface used to create SharedDataHelpers.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedHelper.html" title="interface in com.ibm.oti.shared">SharedHelper</a></div>
<div class="col-last odd-row-color">
<div class="block">The SharedHelper superinterface defines functions common to all helpers.</div>
</div>
</div>
</li>
<li>
<div class="caption"><span>Class Summary</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="Shared.html" title="class in com.ibm.oti.shared">Shared</a></div>
<div class="col-last even-row-color">
<div class="block">Global class that provides SharedClassHelperFactory, SharedDataHelperFactory and sharing status.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedAbstractHelper.html" title="class in com.ibm.oti.shared">SharedAbstractHelper</a></div>
<div class="col-last odd-row-color">
<div class="block">SharedAbstractHelper provides common functions and data to helper subclasses.</div>
</div>
<div class="col-first even-row-color"><a href="SharedAbstractHelperFactory.html" title="class in com.ibm.oti.shared">SharedAbstractHelperFactory</a></div>
<div class="col-last even-row-color">
<div class="block">SharedAbstractHelperFactory is an abstract superclass for helper factory subclasses.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedClassAbstractHelper.html" title="class in com.ibm.oti.shared">SharedClassAbstractHelper</a></div>
<div class="col-last odd-row-color">
<div class="block">SharedClassAbstractHelper provides common functions and data to class helper subclasses.</div>
</div>
<div class="col-first even-row-color"><a href="SharedClassCacheInfo.html" title="class in com.ibm.oti.shared">SharedClassCacheInfo</a></div>
<div class="col-last even-row-color">
<div class="block">SharedClassCacheInfo stores information about a shared class cache and
provides methods to retrieve that information.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedClassesNamedPermission.html" title="class in com.ibm.oti.shared">SharedClassesNamedPermission</a></div>
<div class="col-last odd-row-color">
<div class="block">This class defines shared cache permissions as described in the table below.</div>
</div>
<div class="col-first even-row-color"><a href="SharedClassPermission.html" title="class in com.ibm.oti.shared">SharedClassPermission</a></div>
<div class="col-last even-row-color">
<div class="block">SharedClassPermission provides security permission to govern ClassLoader access to the shared class cache.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedClassPermissionCollection.html" title="class in com.ibm.oti.shared">SharedClassPermissionCollection</a></div>
<div class="col-last odd-row-color">
<div class="block">SharedClassPermissionCollection provides permission collection to support SharedClassPermission</div>
</div>
<div class="col-first even-row-color"><a href="SharedClassStatistics.html" title="class in com.ibm.oti.shared">SharedClassStatistics</a></div>
<div class="col-last even-row-color">
<div class="block">SharedClassStatistics provides static functions that report basic cache statistics.</div>
</div>
<div class="col-first odd-row-color"><a href="SharedClassUtilities.html" title="class in com.ibm.oti.shared">SharedClassUtilities</a></div>
<div class="col-last odd-row-color">
<div class="block">SharedClassUtilities provides APIs to get information about all shared class caches in a directory and
to destroy a particular shared class cache.</div>
</div>
</div>
</li>
<li>
<div class="caption"><span>Exception Summary</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Exception</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="CannotSetClasspathException.html" title="class in com.ibm.oti.shared">CannotSetClasspathException</a></div>
<div class="col-last even-row-color">
<div class="block">Exception thrown if an attempt is made to modify confirmed elements of a
classpath in SharedClassURLClasspathHelper.</div>
</div>
<div class="col-first odd-row-color"><a href="HelperAlreadyDefinedException.html" title="class in com.ibm.oti.shared">HelperAlreadyDefinedException</a></div>
<div class="col-last odd-row-color">
<div class="block">Exception thrown if a factory is asked to get multiple helpers for a ClassLoader.</div>
</div>
</div>
</li>
</ul>
</section>
</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/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>