blob: a51be931d8daece59fd3bc700aeb1b7c2f76cfce [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>SharedClassCacheInfo (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, class: SharedClassCacheInfo">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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="../../../../../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/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>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="sub-nav-list">
<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>
<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>&nbsp;<a href="../../../../module-summary.html">openj9.sharedclasses</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.oti.shared</a></div>
<h1 title="Class SharedClassCacheInfo" class="title">Class SharedClassCacheInfo</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a>
<div class="inheritance">com.ibm.oti.shared.SharedClassCacheInfo</div>
</div>
<section class="description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SharedClassCacheInfo</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span></div>
<div class="block">SharedClassCacheInfo stores information about a shared class cache and
provides methods to retrieve that information.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#ADDRESS_MODE_32">ADDRESS_MODE_32</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies a 32-bit cache.</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#ADDRESS_MODE_64">ADDRESS_MODE_64</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies a 64-bit cache.</div>
</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#COMPRESSED_REFS">COMPRESSED_REFS</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies a compressedRefs cache.</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#COMPRESSED_REFS_UNKNOWN">COMPRESSED_REFS_UNKNOWN</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">The compressedRefs mode is unknown for the cache.</div>
</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#JVMLEVEL_JAVA5">JVMLEVEL_JAVA5</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies a Java 5 cache.</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#JVMLEVEL_JAVA6">JVMLEVEL_JAVA6</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies a Java 6 cache.</div>
</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#JVMLEVEL_JAVA7">JVMLEVEL_JAVA7</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies a Java 7 cache.</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#JVMLEVEL_JAVA8">JVMLEVEL_JAVA8</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies a Java 8 cache.</div>
</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#JVMLEVEL_JAVA9">JVMLEVEL_JAVA9</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">Specifies a Java 9 cache.</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#NON_COMPRESSED_REFS">NON_COMPRESSED_REFS</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies a non-compressedRefs cache.</div>
</div>
</div>
</section>
</li>
<!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4 method-summary-table"><code>int</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheAddressMode()">getCacheAddressMode</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the address mode for the shared class cache.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheCompressedRefsMode()">getCacheCompressedRefsMode</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the compressedRefs mode for the shared class cache.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheFreeBytes()">getCacheFreeBytes</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the amount of free bytes in the shared class cache.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheJVMLevel()">getCacheJVMLevel</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the JVM level for the shared class cache.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheLayer()">getCacheLayer</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the layer number for the shared class cache.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheName()">getCacheName</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the cache name for the shared class cache.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheSize()">getCacheSize</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets total usable shared class cache size.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheSoftMaxBytes()">getCacheSoftMaxBytes</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the soft limit for available space in the cache in bytes.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getCacheType()">getCacheType</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Check the type of the shared class cache.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link" target="_blank">Date</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getLastDetach()">getLastDetach</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the time when the shared class cache was last detached.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getOSsemid()">getOSsemid</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the OS semaphore ID associated with the shared class cache.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getOSshmid()">getOSshmid</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the OS shared memory ID associated with the shared class cache.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isCacheCompatible()">isCacheCompatible</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Checks the compatibility of the shared class cache with this JVM.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isCacheCorrupt()">isCacheCorrupt</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Checks if the shared class cache is corrupt.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isCachePersistent()">isCachePersistent</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use getCacheType() instead.</div>
</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field.detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="JVMLEVEL_JAVA5">
<h3>JVMLEVEL_JAVA5</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">JVMLEVEL_JAVA5</span></div>
<div class="block">Specifies a Java 5 cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA5">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="JVMLEVEL_JAVA6">
<h3>JVMLEVEL_JAVA6</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">JVMLEVEL_JAVA6</span></div>
<div class="block">Specifies a Java 6 cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA6">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="JVMLEVEL_JAVA7">
<h3>JVMLEVEL_JAVA7</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">JVMLEVEL_JAVA7</span></div>
<div class="block">Specifies a Java 7 cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA7">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="JVMLEVEL_JAVA8">
<h3>JVMLEVEL_JAVA8</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">JVMLEVEL_JAVA8</span></div>
<div class="block">Specifies a Java 8 cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA8">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="JVMLEVEL_JAVA9">
<h3>JVMLEVEL_JAVA9</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">JVMLEVEL_JAVA9</span></div>
<div class="block">Specifies a Java 9 cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.JVMLEVEL_JAVA9">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ADDRESS_MODE_32">
<h3>ADDRESS_MODE_32</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ADDRESS_MODE_32</span></div>
<div class="block">Specifies a 32-bit cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.ADDRESS_MODE_32">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ADDRESS_MODE_64">
<h3>ADDRESS_MODE_64</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ADDRESS_MODE_64</span></div>
<div class="block">Specifies a 64-bit cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.ADDRESS_MODE_64">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="COMPRESSED_REFS">
<h3>COMPRESSED_REFS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">COMPRESSED_REFS</span></div>
<div class="block">Specifies a compressedRefs cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.COMPRESSED_REFS">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="NON_COMPRESSED_REFS">
<h3>NON_COMPRESSED_REFS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">NON_COMPRESSED_REFS</span></div>
<div class="block">Specifies a non-compressedRefs cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.NON_COMPRESSED_REFS">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="COMPRESSED_REFS_UNKNOWN">
<h3>COMPRESSED_REFS_UNKNOWN</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">COMPRESSED_REFS_UNKNOWN</span></div>
<div class="block">The compressedRefs mode is unknown for the cache.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.oti.shared.SharedClassCacheInfo.COMPRESSED_REFS_UNKNOWN">Constant Field Values</a></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getCacheName()">
<h3>getCacheName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">getCacheName</span>()</div>
<div class="block">Gets the cache name for the shared class cache.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Name of the shared class cache.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isCacheCompatible()">
<h3>isCacheCompatible</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isCacheCompatible</span>()</div>
<div class="block">Checks the compatibility of the shared class cache with this JVM.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if cache is compatible with this JVM, false otherwise.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isCachePersistent()">
<h3>isCachePersistent</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>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isCachePersistent</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use getCacheType() instead.</div>
</div>
<div class="block">Checks if the shared class cache is persistent.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if cache is persistent, false otherwise.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCacheType()">
<h3>getCacheType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getCacheType</span>()</div>
<div class="block">Check the type of the shared class cache.</div>
<dl class="notes">
<dt>Returns:</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>
</section>
</li>
<li>
<section class="detail" id="getOSshmid()">
<h3>getOSshmid</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getOSshmid</span>()</div>
<div class="block">Gets the OS shared memory ID associated with the shared class cache.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A valid value if cache is non-persistent and shared memory id is available, else -1.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getOSsemid()">
<h3>getOSsemid</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getOSsemid</span>()</div>
<div class="block">Gets the OS semaphore ID associated with the shared class cache.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A valid value if cache is non-persistent and semaphore id is available, else -1.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLastDetach()">
<h3>getLastDetach</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link" target="_blank">Date</a></span>&nbsp;<span class="element-name">getLastDetach</span>()</div>
<div class="block">Gets the time when the shared class cache was last detached.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Date, or null if last detach time is not available.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCacheJVMLevel()">
<h3>getCacheJVMLevel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getCacheJVMLevel</span>()</div>
<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 class="notes">
<dt>Returns:</dt>
<dd>A JVMLEVEL constant.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCacheAddressMode()">
<h3>getCacheAddressMode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getCacheAddressMode</span>()</div>
<div class="block">Gets the address mode for the shared class cache.</div>
<dl class="notes">
<dt>Returns:</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>
</section>
</li>
<li>
<section class="detail" id="isCacheCorrupt()">
<h3>isCacheCorrupt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isCacheCorrupt</span>()</div>
<div class="block">Checks if the shared class cache is corrupt.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if the cache is corrupt, false otherwise.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCacheSize()">
<h3>getCacheSize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getCacheSize</span>()</div>
<div class="block">Gets total usable shared class cache size. Returns -1 if cache is incompatible.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Number of usable bytes in cache.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCacheFreeBytes()">
<h3>getCacheFreeBytes</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getCacheFreeBytes</span>()</div>
<div class="block">Gets the amount of free bytes in the shared class cache. Returns -1 if cache is incompatible.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>long</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCacheSoftMaxBytes()">
<h3>getCacheSoftMaxBytes</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getCacheSoftMaxBytes</span>()</div>
<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 class="notes">
<dt>Returns:</dt>
<dd>long</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCacheCompressedRefsMode()">
<h3>getCacheCompressedRefsMode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getCacheCompressedRefsMode</span>()</div>
<div class="block">Get the compressedRefs mode for the shared class cache.</div>
<dl class="notes">
<dt>Returns:</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>
</section>
</li>
<li>
<section class="detail" id="getCacheLayer()">
<h3>getCacheLayer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getCacheLayer</span>()</div>
<div class="block">Get the layer number for the shared class cache.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The shared cache layer number or -1 if the shared cache does not have a layer number</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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>