blob: 7e1608898d2e9607b863df6f6e22372231c058fb [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SharedClassCacheInfo (OpenJ9 JDK 11)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="com.ibm.oti.shared.SharedClassCacheInfo class">
<meta name="keywords" content="JVMLEVEL_JAVA5">
<meta name="keywords" content="JVMLEVEL_JAVA6">
<meta name="keywords" content="JVMLEVEL_JAVA7">
<meta name="keywords" content="JVMLEVEL_JAVA8">
<meta name="keywords" content="JVMLEVEL_JAVA9">
<meta name="keywords" content="ADDRESS_MODE_32">
<meta name="keywords" content="ADDRESS_MODE_64">
<meta name="keywords" content="COMPRESSED_REFS">
<meta name="keywords" content="NON_COMPRESSED_REFS">
<meta name="keywords" content="COMPRESSED_REFS_UNKNOWN">
<meta name="keywords" content="getCacheName()">
<meta name="keywords" content="isCacheCompatible()">
<meta name="keywords" content="isCachePersistent()">
<meta name="keywords" content="getCacheType()">
<meta name="keywords" content="getOSshmid()">
<meta name="keywords" content="getOSsemid()">
<meta name="keywords" content="getLastDetach()">
<meta name="keywords" content="getCacheJVMLevel()">
<meta name="keywords" content="getCacheAddressMode()">
<meta name="keywords" content="isCacheCorrupt()">
<meta name="keywords" content="getCacheSize()">
<meta name="keywords" content="getCacheFreeBytes()">
<meta name="keywords" content="getCacheSoftMaxBytes()">
<meta name="keywords" content="getCacheCompressedRefsMode()">
<meta name="keywords" content="getCacheLayer()">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SharedClassCacheInfo (OpenJ9 JDK 11)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" 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="navBarCell1Rev">Class</li>
<li><a href="class-use/SharedClassCacheInfo.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 class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../../../module-summary.html">openj9.sharedclasses</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.ibm.oti.shared</a></div>
<h2 title="Class SharedClassCacheInfo" class="title">Class SharedClassCacheInfo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.ibm.oti.shared.SharedClassCacheInfo</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">SharedClassCacheInfo</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a></pre>
<div class="block">SharedClassCacheInfo stores information about a shared class cache and
provides methods to retrieve that information.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ADDRESS_MODE_32">ADDRESS_MODE_32</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a 32-bit cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ADDRESS_MODE_64">ADDRESS_MODE_64</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a 64-bit cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#COMPRESSED_REFS">COMPRESSED_REFS</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a compressedRefs cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#COMPRESSED_REFS_UNKNOWN">COMPRESSED_REFS_UNKNOWN</a></span></code></th>
<td class="colLast">
<div class="block">The compressedRefs mode is unknown for the cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JVMLEVEL_JAVA5">JVMLEVEL_JAVA5</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a Java 5 cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JVMLEVEL_JAVA6">JVMLEVEL_JAVA6</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a Java 6 cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JVMLEVEL_JAVA7">JVMLEVEL_JAVA7</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a Java 7 cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JVMLEVEL_JAVA8">JVMLEVEL_JAVA8</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a Java 8 cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JVMLEVEL_JAVA9">JVMLEVEL_JAVA9</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a Java 9 cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NON_COMPRESSED_REFS">NON_COMPRESSED_REFS</a></span></code></th>
<td class="colLast">
<div class="block">Specifies a non-compressedRefs cache.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheAddressMode()">getCacheAddressMode</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the address mode for the shared class cache.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheCompressedRefsMode()">getCacheCompressedRefsMode</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the compressedRefs mode for the shared class cache.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheFreeBytes()">getCacheFreeBytes</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the amount of free bytes in the shared class cache.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheJVMLevel()">getCacheJVMLevel</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the JVM level for the shared class cache.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheLayer()">getCacheLayer</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the layer number for the shared class cache.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheName()">getCacheName</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the cache name for the shared class cache.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheSize()">getCacheSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets total usable shared class cache size.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheSoftMaxBytes()">getCacheSoftMaxBytes</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the soft limit for available space in the cache in bytes.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheType()">getCacheType</a></span>()</code></th>
<td class="colLast">
<div class="block">Check the type of the shared class cache.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Date</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastDetach()">getLastDetach</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the time when the shared class cache was last detached.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOSsemid()">getOSsemid</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the OS semaphore ID associated with the shared class cache.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOSshmid()">getOSshmid</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the OS shared memory ID associated with the shared class cache.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCacheCompatible()">isCacheCompatible</a></span>()</code></th>
<td class="colLast">
<div class="block">Checks the compatibility of the shared class cache with this JVM.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCacheCorrupt()">isCacheCorrupt</a></span>()</code></th>
<td class="colLast">
<div class="block">Checks if the shared class cache is corrupt.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCachePersistent()">isCachePersistent</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use getCacheType() instead.</div>
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="JVMLEVEL_JAVA5">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JVMLEVEL_JAVA5</h4>
<pre>public static final&nbsp;int JVMLEVEL_JAVA5</pre>
<div class="block">Specifies a Java 5 cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA5">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JVMLEVEL_JAVA6">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JVMLEVEL_JAVA6</h4>
<pre>public static final&nbsp;int JVMLEVEL_JAVA6</pre>
<div class="block">Specifies a Java 6 cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA6">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JVMLEVEL_JAVA7">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JVMLEVEL_JAVA7</h4>
<pre>public static final&nbsp;int JVMLEVEL_JAVA7</pre>
<div class="block">Specifies a Java 7 cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA7">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JVMLEVEL_JAVA8">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JVMLEVEL_JAVA8</h4>
<pre>public static final&nbsp;int JVMLEVEL_JAVA8</pre>
<div class="block">Specifies a Java 8 cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA8">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JVMLEVEL_JAVA9">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JVMLEVEL_JAVA9</h4>
<pre>public static final&nbsp;int JVMLEVEL_JAVA9</pre>
<div class="block">Specifies a Java 9 cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA9">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="ADDRESS_MODE_32">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ADDRESS_MODE_32</h4>
<pre>public static final&nbsp;int ADDRESS_MODE_32</pre>
<div class="block">Specifies a 32-bit cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.ADDRESS_MODE_32">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="ADDRESS_MODE_64">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ADDRESS_MODE_64</h4>
<pre>public static final&nbsp;int ADDRESS_MODE_64</pre>
<div class="block">Specifies a 64-bit cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.ADDRESS_MODE_64">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="COMPRESSED_REFS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMPRESSED_REFS</h4>
<pre>public static final&nbsp;int COMPRESSED_REFS</pre>
<div class="block">Specifies a compressedRefs cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.COMPRESSED_REFS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="NON_COMPRESSED_REFS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NON_COMPRESSED_REFS</h4>
<pre>public static final&nbsp;int NON_COMPRESSED_REFS</pre>
<div class="block">Specifies a non-compressedRefs cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.NON_COMPRESSED_REFS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="COMPRESSED_REFS_UNKNOWN">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>COMPRESSED_REFS_UNKNOWN</h4>
<pre>public static final&nbsp;int COMPRESSED_REFS_UNKNOWN</pre>
<div class="block">The compressedRefs mode is unknown for the cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.COMPRESSED_REFS_UNKNOWN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getCacheName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheName</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>&nbsp;getCacheName()</pre>
<div class="block">Gets the cache name for the shared class cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Name of the shared class cache.</dd>
</dl>
</li>
</ul>
<a id="isCacheCompatible()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheCompatible</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCacheCompatible()</pre>
<div class="block">Checks the compatibility of the shared class cache with this JVM.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if cache is compatible with this JVM, false otherwise.</dd>
</dl>
</li>
</ul>
<a id="isCachePersistent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCachePersistent</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">@Deprecated</a>
public&nbsp;boolean&nbsp;isCachePersistent()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use getCacheType() instead.</div>
</div>
<div class="block">Checks if the shared class cache is persistent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if cache is persistent, false otherwise.</dd>
</dl>
</li>
</ul>
<a id="getCacheType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheType</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getCacheType()</pre>
<div class="block">Check the type of the shared class cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Either <a href="SharedClassUtilities.html#PERSISTENT"><code>SharedClassUtilities.PERSISTENT</code></a>,
<a href="SharedClassUtilities.html#NONPERSISTENT"><code>SharedClassUtilities.NONPERSISTENT</code></a> or
<a href="SharedClassUtilities.html#SNAPSHOT"><code>SharedClassUtilities.SNAPSHOT</code></a></dd>
</dl>
</li>
</ul>
<a id="getOSshmid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOSshmid</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getOSshmid()</pre>
<div class="block">Gets the OS shared memory ID associated with the shared class cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A valid value if cache is non-persistent and shared memory id is available, else -1.</dd>
</dl>
</li>
</ul>
<a id="getOSsemid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOSsemid</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getOSsemid()</pre>
<div class="block">Gets the OS semaphore ID associated with the shared class cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A valid value if cache is non-persistent and semaphore id is available, else -1.</dd>
</dl>
</li>
</ul>
<a id="getLastDetach()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastDetach</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Date</a>&nbsp;getLastDetach()</pre>
<div class="block">Gets the time when the shared class cache was last detached.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Date, or null if last detach time is not available.</dd>
</dl>
</li>
</ul>
<a id="getCacheJVMLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheJVMLevel</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getCacheJVMLevel()</pre>
<div class="block">Gets the JVM level for the shared class cache.
Starting from Java 10, the JVM LEVEL equals to the java version number on which the share class cache is created.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A JVMLEVEL constant.</dd>
</dl>
</li>
</ul>
<a id="getCacheAddressMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheAddressMode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getCacheAddressMode()</pre>
<div class="block">Gets the address mode for the shared class cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Either <a href="#ADDRESS_MODE_32"><code>ADDRESS_MODE_32</code></a> or
<a href="#ADDRESS_MODE_64"><code>ADDRESS_MODE_64</code></a></dd>
</dl>
</li>
</ul>
<a id="isCacheCorrupt()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheCorrupt</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCacheCorrupt()</pre>
<div class="block">Checks if the shared class cache is corrupt.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the cache is corrupt, false otherwise.</dd>
</dl>
</li>
</ul>
<a id="getCacheSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheSize</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getCacheSize()</pre>
<div class="block">Gets total usable shared class cache size. Returns -1 if cache is incompatible.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of usable bytes in cache.</dd>
</dl>
</li>
</ul>
<a id="getCacheFreeBytes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheFreeBytes</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getCacheFreeBytes()</pre>
<div class="block">Gets the amount of free bytes in the shared class cache. Returns -1 if cache is incompatible.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>long</dd>
</dl>
</li>
</ul>
<a id="getCacheSoftMaxBytes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheSoftMaxBytes</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getCacheSoftMaxBytes()</pre>
<div class="block">Get the soft limit for available space in the cache in bytes. Returns -1 if cache is incompatible or cache size if it is not set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>long</dd>
</dl>
</li>
</ul>
<a id="getCacheCompressedRefsMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheCompressedRefsMode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getCacheCompressedRefsMode()</pre>
<div class="block">Get the compressedRefs mode for the shared class cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Either <a href="#COMPRESSED_REFS"><code>COMPRESSED_REFS</code></a> or
<a href="#NON_COMPRESSED_REFS"><code>NON_COMPRESSED_REFS</code></a> or
<a href="#COMPRESSED_REFS_UNKNOWN"><code>COMPRESSED_REFS_UNKNOWN</code></a></dd>
</dl>
</li>
</ul>
<a id="getCacheLayer()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCacheLayer</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getCacheLayer()</pre>
<div class="block">Get the layer number for the shared class cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The shared cache layer number or -1 if the shared cache does not have a layer number</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" 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="navBarCell1Rev">Class</li>
<li><a href="class-use/SharedClassCacheInfo.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 class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<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>
</footer>
</body>
</html>