Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk8 / platform / sharedclasses / com / ibm / oti / shared / SharedClassUtilities.html
blob: de80224d2f605b2396c577e0fe8aac1cf8f7ea54 [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>SharedClassUtilities (OpenJ9 Shared Classes)</title>
<meta name="keywords" content="com.ibm.oti.shared.SharedClassUtilities class">
<meta name="keywords" content="NO_FLAGS">
<meta name="keywords" content="PERSISTENCE_DEFAULT">
<meta name="keywords" content="PERSISTENT">
<meta name="keywords" content="NONPERSISTENT">
<meta name="keywords" content="SNAPSHOT">
<meta name="keywords" content="DESTROYED_ALL_CACHE">
<meta name="keywords" content="DESTROYED_NONE">
<meta name="keywords" content="DESTROY_FAILED_CURRENT_GEN_CACHE">
<meta name="keywords" content="DESTROY_FAILED_OLDER_GEN_CACHE">
<meta name="keywords" content="getSharedCacheInfo()">
<meta name="keywords" content="destroySharedCache()">
<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="SharedClassUtilities (OpenJ9 Shared Classes)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/SharedClassUtilities.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/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/oti/shared/SharedDataHelper.html" title="interface 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/SharedClassUtilities.html" target="_top">Frames</a></li>
<li><a href="SharedClassUtilities.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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 SharedClassUtilities" class="title">Class SharedClassUtilities</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.SharedClassUtilities</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SharedClassUtilities</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">SharedClassUtilities provides APIs to get information about all shared class caches in a directory and
to destroy a particular shared class cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html" title="class in com.ibm.oti.shared"><code>SharedClassCacheInfo</code></a></dd>
</dl>
</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/SharedClassUtilities.html#DESTROY_FAILED_CURRENT_GEN_CACHE">DESTROY_FAILED_CURRENT_GEN_CACHE</a></span></code>
<div class="block">Returned by <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-"><code>destroySharedCache(java.lang.String, int, java.lang.String, boolean)</code></a> to indicate that the method has failed to destroy the
current generation 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/SharedClassUtilities.html#DESTROY_FAILED_OLDER_GEN_CACHE">DESTROY_FAILED_OLDER_GEN_CACHE</a></span></code>
<div class="block">Returned by <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-"><code>destroySharedCache(java.lang.String, int, java.lang.String, boolean)</code></a> to indicate that the method has failed to destroy one
or more older generation caches, and either a current generation cache does not exist or is successfully destroyed.</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/SharedClassUtilities.html#DESTROYED_ALL_CACHE">DESTROYED_ALL_CACHE</a></span></code>
<div class="block">Returned by <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-"><code>destroySharedCache(java.lang.String, int, java.lang.String, boolean)</code></a> to indicate either no cache exists
or the method has successfully destroyed caches of all generations.</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/SharedClassUtilities.html#DESTROYED_NONE">DESTROYED_NONE</a></span></code>
<div class="block">Returned by <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-"><code>destroySharedCache(java.lang.String, int, java.lang.String, boolean)</code></a> to indicate that the method failed to destroy any 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/SharedClassUtilities.html#NO_FLAGS">NO_FLAGS</a></span></code>
<div class="block">Value to be passed to <code>flags</code> parameter of the <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#getSharedCacheInfo-java.lang.String-int-boolean-"><code>getSharedCacheInfo(java.lang.String, int, boolean)</code></a> method.</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/SharedClassUtilities.html#NONPERSISTENT">NONPERSISTENT</a></span></code>
<div class="block">Specifies a non-persistent 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/SharedClassUtilities.html#PERSISTENCE_DEFAULT">PERSISTENCE_DEFAULT</a></span></code>
<div class="block">Uses the platform dependent default value as the cache type.</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/SharedClassUtilities.html#PERSISTENT">PERSISTENT</a></span></code>
<div class="block">Specifies a persistent 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/SharedClassUtilities.html#SNAPSHOT">SNAPSHOT</a></span></code>
<div class="block">Specifies a cache snapshot.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#SharedClassUtilities--">SharedClassUtilities</a></span>()</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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></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>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-">destroySharedCache</a></span>(<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;cacheDir,
int&nbsp;cacheType,
<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;cacheName,
boolean&nbsp;useCommandLineValues)</code>
<div class="block">Destroys a named shared class cache of a given type in a given directory.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" target="_blank" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html" title="class in com.ibm.oti.shared">SharedClassCacheInfo</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#getSharedCacheInfo-java.lang.String-int-boolean-">getSharedCacheInfo</a></span>(<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;cacheDir,
int&nbsp;flags,
boolean&nbsp;useCommandLineValues)</code>
<div class="block">Iterates through all shared class caches present in the given directory and returns their information in
a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" target="_blank" title="class or interface in java.util"><code>List</code></a>.</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="NO_FLAGS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_FLAGS</h4>
<pre>public static final&nbsp;int NO_FLAGS</pre>
<div class="block">Value to be passed to <code>flags</code> parameter of the <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#getSharedCacheInfo-java.lang.String-int-boolean-"><code>getSharedCacheInfo(java.lang.String, int, boolean)</code></a> method.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.NO_FLAGS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PERSISTENCE_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERSISTENCE_DEFAULT</h4>
<pre>public static final&nbsp;int PERSISTENCE_DEFAULT</pre>
<div class="block">Uses the platform dependent default value as the cache type.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.PERSISTENCE_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PERSISTENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERSISTENT</h4>
<pre>public static final&nbsp;int PERSISTENT</pre>
<div class="block">Specifies a persistent cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.PERSISTENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="NONPERSISTENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NONPERSISTENT</h4>
<pre>public static final&nbsp;int NONPERSISTENT</pre>
<div class="block">Specifies a non-persistent cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.NONPERSISTENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SNAPSHOT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SNAPSHOT</h4>
<pre>public static final&nbsp;int SNAPSHOT</pre>
<div class="block">Specifies a cache snapshot.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.SNAPSHOT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DESTROYED_ALL_CACHE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DESTROYED_ALL_CACHE</h4>
<pre>public static final&nbsp;int DESTROYED_ALL_CACHE</pre>
<div class="block">Returned by <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-"><code>destroySharedCache(java.lang.String, int, java.lang.String, boolean)</code></a> to indicate either no cache exists
or the method has successfully destroyed caches of all generations.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.DESTROYED_ALL_CACHE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DESTROYED_NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DESTROYED_NONE</h4>
<pre>public static final&nbsp;int DESTROYED_NONE</pre>
<div class="block">Returned by <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-"><code>destroySharedCache(java.lang.String, int, java.lang.String, boolean)</code></a> to indicate that the method failed to destroy any cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.DESTROYED_NONE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DESTROY_FAILED_CURRENT_GEN_CACHE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DESTROY_FAILED_CURRENT_GEN_CACHE</h4>
<pre>public static final&nbsp;int DESTROY_FAILED_CURRENT_GEN_CACHE</pre>
<div class="block">Returned by <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-"><code>destroySharedCache(java.lang.String, int, java.lang.String, boolean)</code></a> to indicate that the method has failed to destroy the
current generation cache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.DESTROY_FAILED_CURRENT_GEN_CACHE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DESTROY_FAILED_OLDER_GEN_CACHE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DESTROY_FAILED_OLDER_GEN_CACHE</h4>
<pre>public static final&nbsp;int DESTROY_FAILED_OLDER_GEN_CACHE</pre>
<div class="block">Returned by <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#destroySharedCache-java.lang.String-int-java.lang.String-boolean-"><code>destroySharedCache(java.lang.String, int, java.lang.String, boolean)</code></a> to indicate that the method has failed to destroy one
or more older generation caches, and either a current generation cache does not exist or is successfully destroyed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.oti.shared.SharedClassUtilities.DESTROY_FAILED_OLDER_GEN_CACHE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SharedClassUtilities--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SharedClassUtilities</h4>
<pre>public&nbsp;SharedClassUtilities()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSharedCacheInfo-java.lang.String-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSharedCacheInfo</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" target="_blank" title="class or interface in java.util">List</a>&lt;<a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html" title="class in com.ibm.oti.shared">SharedClassCacheInfo</a>&gt;&nbsp;getSharedCacheInfo(<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;cacheDir,
int&nbsp;flags,
boolean&nbsp;useCommandLineValues)</pre>
<div class="block">Iterates through all shared class caches present in the given directory and returns their information in
a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" target="_blank" title="class or interface in java.util"><code>List</code></a>.
<p>
If <code>useCommandLineValues</code> is <code>true</code> then use the command line value as the directory to search in.
If the command line value is not available, use the platform dependent default value.
If <code>useCommandLineValues</code> is <code>false</code>, then use <code>cacheDir</code> as the directory to search in.
<code>cacheDir</code> can be <code>null</code>. In such a case, use the platform dependent default value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheDir</code> - Absolute path of the directory to look for the shared class caches</dd>
<dd><code>flags</code> - Reserved for future use. Always pass <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#NO_FLAGS"><code>NO_FLAGS</code></a></dd>
<dd><code>useCommandLineValues</code> - Use command line values instead of using parameter values</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of <a href="../../../../com/ibm/oti/shared/SharedClassCacheInfo.html" title="class in com.ibm.oti.shared"><code>SharedClassCacheInfo</code></a> corresponding to shared class caches which are present
in the specified directory, <code>null</code> on failure.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - If shared classes is disabled for this JVM (that is -Xshareclasses:none is present).</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>flags</code> is not a valid value.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" target="_blank" title="class or interface in java.lang">SecurityException</a></code> - If a security manager is enabled and the calling thread does not
have SharedClassesNamedPermission("getSharedCacheInfo")</dd>
</dl>
</li>
</ul>
<a name="destroySharedCache-java.lang.String-int-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>destroySharedCache</h4>
<pre>public static&nbsp;int&nbsp;destroySharedCache(<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;cacheDir,
int&nbsp;cacheType,
<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;cacheName,
boolean&nbsp;useCommandLineValues)</pre>
<div class="block">Destroys a named shared class cache of a given type in a given directory. If the shared class cache has multiple layers, this function will destroy the top layer only.
<p>
If <code>useCommandLineValues</code> is <code>true</code>, then use the command line value to get the shared class cache name,
its type and its directory. If any of these is not available, then use the default value.
If <code>useCommandLineValues</code> is <code>false</code>, then use <code>cacheDir</code>, <code>persistence</code>, and
<code>cacheName</code> to identify the cache to be destroyed. To accept the default value for <code>cacheDir</code>
or <code>cacheName</code>, specify the parameter with a <code>null</code> value.
<p>
The return value of this method depends on the status of existing current and older generation caches.
<ul>
<li>If it fails to destroy any existing cache with the given name, it returns
<a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#DESTROYED_NONE"><code>DESTROYED_NONE</code></a>.
<li>If no cache exists or it is able to destroy all existing caches of all generations, it returns
<a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#DESTROYED_ALL_CACHE"><code>DESTROYED_ALL_CACHE</code></a>.<br>
<li>If it fails to destroy an existing current generation cache, irrespective of the state of older generation
caches, it returns <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#DESTROY_FAILED_CURRENT_GEN_CACHE"><code>DESTROY_FAILED_CURRENT_GEN_CACHE</code></a>.<br>
<li>If it fails to destroy one or more older generation caches, and either a current generation cache does not
exist or is successfully destroyed, it returns <a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#DESTROY_FAILED_OLDER_GEN_CACHE"><code>DESTROY_FAILED_OLDER_GEN_CACHE</code></a>.<br>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheDir</code> - Absolute path of the directory where the shared class cache is present</dd>
<dd><code>cacheType</code> - Type of the cache. The type has one of the following values:
<ul>
<li><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#PERSISTENCE_DEFAULT"><code>PERSISTENCE_DEFAULT</code></a>
<li><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#PERSISTENT"><code>PERSISTENT</code></a>
<li><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#NONPERSISTENT"><code>NONPERSISTENT</code></a>
<li><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#SNAPSHOT"><code>SNAPSHOT</code></a>
</ul></dd>
<dd><code>cacheName</code> - Name of the cache to be deleted</dd>
<dd><code>useCommandLineValues</code> - Use command line values instead of using parameter values</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns one of the following values:
<ul>
<li><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#DESTROYED_ALL_CACHE"><code>DESTROYED_ALL_CACHE</code></a>
<li><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#DESTROYED_NONE"><code>DESTROYED_NONE</code></a>
<li><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#DESTROY_FAILED_CURRENT_GEN_CACHE"><code>DESTROY_FAILED_CURRENT_GEN_CACHE</code></a>
<li><a href="../../../../com/ibm/oti/shared/SharedClassUtilities.html#DESTROY_FAILED_OLDER_GEN_CACHE"><code>DESTROY_FAILED_OLDER_GEN_CACHE</code></a>
</ul></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - If shared classes is disabled for this JVM (that is -Xshareclasses:none is present).</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>cacheType</code> is not a valid value.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/SecurityException.html?is-external=true" target="_blank" title="class or interface in java.lang">SecurityException</a></code> - If a security manager is enabled and the calling thread does not
have SharedClassesNamedPermission("destroySharedCache")</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/SharedClassUtilities.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/SharedClassURLHelper.html" title="interface in com.ibm.oti.shared"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/oti/shared/SharedDataHelper.html" title="interface 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/SharedClassUtilities.html" target="_top">Frames</a></li>
<li><a href="SharedClassUtilities.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>