Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk8 / platform / sharedclasses / com / ibm / oti / shared / SharedClassCacheInfo.html
blob: 3734bd850d2f81c316bdc69bd818764c71ca688a [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>SharedClassCacheInfo (OpenJ9 Shared Classes)</title>
<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="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">
<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="SharedClassCacheInfo (OpenJ9 Shared Classes)";
}
}
catch(err) {
}
//-->
var methods = {"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";
</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/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-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/SharedClassAbstractHelper.html" title="class in com.ibm.oti.shared"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/oti/shared/SharedClassesNamedPermission.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/SharedClassCacheInfo.html" target="_top">Frames</a></li>
<li><a href="SharedClassCacheInfo.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><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 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="Class SharedClassCacheInfo" class="title">Class SharedClassCacheInfo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">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>
<br>
<pre>public class <span class="typeNameLabel">SharedClassCacheInfo</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#ADDRESS_MODE_32">ADDRESS_MODE_32</a></span></code>
<div class="block">Specifies a 32-bit cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#ADDRESS_MODE_64">ADDRESS_MODE_64</a></span></code>
<div class="block">Specifies a 64-bit cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#COMPRESSED_REFS">COMPRESSED_REFS</a></span></code>
<div class="block">Specifies a compressedRefs cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#COMPRESSED_REFS_UNKNOWN">COMPRESSED_REFS_UNKNOWN</a></span></code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#JVMLEVEL_JAVA5">JVMLEVEL_JAVA5</a></span></code>
<div class="block">Specifies a Java 5 cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#JVMLEVEL_JAVA6">JVMLEVEL_JAVA6</a></span></code>
<div class="block">Specifies a Java 6 cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#JVMLEVEL_JAVA7">JVMLEVEL_JAVA7</a></span></code>
<div class="block">Specifies a Java 7 cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#JVMLEVEL_JAVA8">JVMLEVEL_JAVA8</a></span></code>
<div class="block">Specifies a Java 8 cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#NON_COMPRESSED_REFS">NON_COMPRESSED_REFS</a></span></code>
<div class="block">Specifies a non-compressedRefs cache.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheAddressMode--">getCacheAddressMode</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheCompressedRefsMode--">getCacheCompressedRefsMode</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheFreeBytes--">getCacheFreeBytes</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheJVMLevel--">getCacheJVMLevel</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheLayer--">getCacheLayer</a></span>()</code>
<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/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheName--">getCacheName</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheSize--">getCacheSize</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheSoftMaxBytes--">getCacheSoftMaxBytes</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getCacheType--">getCacheType</a></span>()</code>
<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/javase/8/docs/api/java/util/Date.html?is-external=true" target="_blank" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getLastDetach--">getLastDetach</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getOSsemid--">getOSsemid</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#getOSshmid--">getOSshmid</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#isCacheCompatible--">isCacheCompatible</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#isCacheCorrupt--">isCacheCorrupt</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#isCachePersistent--">isCachePersistent</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use getCacheType() instead.</span></div>
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="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 name="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 name="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 name="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 name="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 name="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 name="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 name="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 name="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>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCacheName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">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 name="isCacheCompatible--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheCompatible</h4>
<pre>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 name="isCachePersistent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCachePersistent</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" target="_blank" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;isCachePersistent()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use getCacheType() instead.</span></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 name="getCacheType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheType</h4>
<pre>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="../../../../com/ibm/oti/shared/SharedClassUtilities.html#PERSISTENT"><code>SharedClassUtilities.PERSISTENT</code></a>,
<a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#NONPERSISTENT"><code>SharedClassUtilities.NONPERSISTENT</code></a> or
<a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#SNAPSHOT"><code>SharedClassUtilities.SNAPSHOT</code></a></dd>
</dl>
</li>
</ul>
<a name="getOSshmid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOSshmid</h4>
<pre>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 name="getOSsemid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOSsemid</h4>
<pre>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 name="getLastDetach--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastDetach</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" target="_blank" title="class or interface in java.util">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 name="getCacheJVMLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheJVMLevel</h4>
<pre>public&nbsp;int&nbsp;getCacheJVMLevel()</pre>
<div class="block">Gets the JVM level for the shared class cache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A JVMLEVEL constant.</dd>
</dl>
</li>
</ul>
<a name="getCacheAddressMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheAddressMode</h4>
<pre>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="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#ADDRESS_MODE_32"><code>ADDRESS_MODE_32</code></a> or
<a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#ADDRESS_MODE_64"><code>ADDRESS_MODE_64</code></a></dd>
</dl>
</li>
</ul>
<a name="isCacheCorrupt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheCorrupt</h4>
<pre>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 name="getCacheSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheSize</h4>
<pre>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 name="getCacheFreeBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheFreeBytes</h4>
<pre>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 name="getCacheSoftMaxBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheSoftMaxBytes</h4>
<pre>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 name="getCacheCompressedRefsMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheCompressedRefsMode</h4>
<pre>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="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#COMPRESSED_REFS"><code>COMPRESSED_REFS</code></a> or
<a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#NON_COMPRESSED_REFS"><code>NON_COMPRESSED_REFS</code></a> or
<a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html#COMPRESSED_REFS_UNKNOWN"><code>COMPRESSED_REFS_UNKNOWN</code></a></dd>
</dl>
</li>
</ul>
<a name="getCacheLayer--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCacheLayer</h4>
<pre>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>
</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/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-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/SharedClassAbstractHelper.html" title="class in com.ibm.oti.shared"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/oti/shared/SharedClassesNamedPermission.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/SharedClassCacheInfo.html" target="_top">Frames</a></li>
<li><a href="SharedClassCacheInfo.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><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 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>