| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>J9DDRDTFJUtils (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.dtfj, package: com.ibm.j9ddr.view.dtfj, class: J9DDRDTFJUtils"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.j9ddr.view.dtfj.J9DDRDTFJUtils class"> |
| <meta name="keywords" content="emptyIterator()"> |
| <meta name="keywords" content="corruptIterator()"> |
| <meta name="keywords" content="newCorruptData()"> |
| <meta name="keywords" content="newCorruptDataException()"> |
| <meta name="keywords" content="handleAllButDataUnavailAsCorruptDataException()"> |
| <meta name="keywords" content="handleAllButMemAccExAsCorruptDataException()"> |
| <meta name="keywords" content="handleAllButMemAccExAndDataUnavailAsCorruptDataException()"> |
| <meta name="keywords" content="handleAsCorruptDataException()"> |
| <meta name="keywords" content="handleAsCorruptData()"> |
| <meta name="keywords" content="handleAsDataUnavailable()"> |
| <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/J9DDRDTFJUtils.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> <a href="../../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.j9ddr.view.dtfj</a></div> |
| <h1 title="Class J9DDRDTFJUtils" class="title">Class J9DDRDTFJUtils</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.j9ddr.view.dtfj.J9DDRDTFJUtils</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">J9DDRDTFJUtils</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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor.summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E()">J9DDRDTFJUtils</a></span>()</code></div> |
| <div class="col-last even-row-color"> </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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></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-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#corruptIterator(com.ibm.dtfj.image.CorruptData)">corruptIterator</a></span>​(<a href="../../../dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image">CorruptData</a> data)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Return an iterator which contains a single corrupt data item</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#emptyIterator()">emptyIterator</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#handleAllButDataUnavailAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable)">handleAllButDataUnavailAsCorruptDataException</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Go through the standard handleAsCorruptDataException method to convert the supplied error condition |
| into a corrupt data exception as long as it is not present in the allow list |
| AND especially for this method, if it is not a DataUnavailable.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#handleAllButMemAccExAndDataUnavailAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable,java.lang.Class%5B%5D)">handleAllButMemAccExAndDataUnavailAsCorruptDataException</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?>[] allowlist)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Go through the standard handleAsCorruptDataException method to convert the supplied error condition |
| into a corrupt data exception as long as it is not present in the allow list |
| AND especially for this method, if it is neither MemoryAccessException or DataUnavailable.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#handleAllButMemAccExAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable,java.lang.Class%5B%5D)">handleAllButMemAccExAsCorruptDataException</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?>[] allowlist)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Go through the standard handleAsCorruptDataException method to convert the supplied error condition |
| into a corrupt data exception as long as it is not present in the allow list |
| AND especially for this method, if it is not a MemoryAccessException.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="../../../dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image">CorruptData</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#handleAsCorruptData(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable)">handleAsCorruptData</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Convert the supplied error condition into a CorruptData object and return |
| it, typically for insertion into an iterator, |
| or re-throw it if it is an instance of Error that we do not want to |
| intercept.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#handleAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable)">handleAsCorruptDataException</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Convert the supplied error condition into a corrupt data exception |
| or re-throw it if it is an instance of Error that we do not want to |
| intercept.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#handleAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable,java.lang.Class%5B%5D)">handleAsCorruptDataException</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?>[] allowlist)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Go through the standard handleAsCorruptDataException method to convert the supplied error condition |
| into a corrupt data exception as long as it is not present in the allow list.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="../../../dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#handleAsDataUnavailable(java.lang.Throwable)">handleAsDataUnavailable</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Handle the supplied error condition and ultimately surface it as a |
| data unavailable exception.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="image/J9DDRCorruptData.html" title="class in com.ibm.j9ddr.view.dtfj.image">J9DDRCorruptData</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#newCorruptData(com.ibm.j9ddr.corereaders.memory.IProcess)">newCorruptData</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> process)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Create a j9ddr corrupt data</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="image/J9DDRCorruptData.html" title="class in com.ibm.j9ddr.view.dtfj.image">J9DDRCorruptData</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#newCorruptData(com.ibm.j9ddr.corereaders.memory.IProcess,com.ibm.j9ddr.CorruptDataException)">newCorruptData</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> process, |
| <a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a> e)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Create a j9ddr corrupt data</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="image/J9DDRCorruptData.html" title="class in com.ibm.j9ddr.view.dtfj.image">J9DDRCorruptData</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#newCorruptData(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.String)">newCorruptData</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> process, |
| <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> message)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Create a j9ddr corrupt data</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#newCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,com.ibm.j9ddr.CorruptDataException)">newCorruptDataException</a></span>​(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> process, |
| <a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a> e)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Convert a j9ddr corrupt data exception into a DTFJ corrupt data exception</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor.detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>J9DDRDTFJUtils</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">J9DDRDTFJUtils</span>()</div> |
| </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="emptyIterator()"> |
| <h3>emptyIterator</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">emptyIterator</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="corruptIterator(com.ibm.dtfj.image.CorruptData)"> |
| <h3>corruptIterator</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span> <span class="element-name">corruptIterator</span>​<span class="parameters">(<a href="../../../dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image">CorruptData</a> data)</span></div> |
| <div class="block">Return an iterator which contains a single corrupt data item</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>data</code> - </dd> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newCorruptData(com.ibm.j9ddr.corereaders.memory.IProcess,com.ibm.j9ddr.CorruptDataException)"> |
| <h3>newCorruptData</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="image/J9DDRCorruptData.html" title="class in com.ibm.j9ddr.view.dtfj.image">J9DDRCorruptData</a></span> <span class="element-name">newCorruptData</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> process, |
| <a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a> e)</span></div> |
| <div class="block">Create a j9ddr corrupt data</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>process</code> - the process from the dtfj context</dd> |
| <dd><code>e</code> - a DTFJ CDE</dd> |
| <dt>Returns:</dt> |
| <dd>a j9ddr corrupt data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newCorruptData(com.ibm.j9ddr.corereaders.memory.IProcess)"> |
| <h3>newCorruptData</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="image/J9DDRCorruptData.html" title="class in com.ibm.j9ddr.view.dtfj.image">J9DDRCorruptData</a></span> <span class="element-name">newCorruptData</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> process)</span></div> |
| <div class="block">Create a j9ddr corrupt data</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>process</code> - the process from the dtfj context</dd> |
| <dt>Returns:</dt> |
| <dd>a j9ddr corrupt data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newCorruptData(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.String)"> |
| <h3>newCorruptData</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="image/J9DDRCorruptData.html" title="class in com.ibm.j9ddr.view.dtfj.image">J9DDRCorruptData</a></span> <span class="element-name">newCorruptData</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> process, |
| <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> message)</span></div> |
| <div class="block">Create a j9ddr corrupt data</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>process</code> - the process from the dtfj context</dd> |
| <dd><code>message</code> - message</dd> |
| <dt>Returns:</dt> |
| <dd>a j9ddr corrupt data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,com.ibm.j9ddr.CorruptDataException)"> |
| <h3>newCorruptDataException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span> <span class="element-name">newCorruptDataException</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> process, |
| <a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a> e)</span></div> |
| <div class="block">Convert a j9ddr corrupt data exception into a DTFJ corrupt data exception</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>process</code> - the process from the dtfj context</dd> |
| <dd><code>e</code> - the j9ddr CDE</dd> |
| <dt>Returns:</dt> |
| <dd>a DTFJ CDE</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleAllButDataUnavailAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable)"> |
| <h3>handleAllButDataUnavailAsCorruptDataException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span> <span class="element-name">handleAllButDataUnavailAsCorruptDataException</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t)</span> |
| throws <span class="exceptions"><a href="../../../dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span></div> |
| <div class="block">Go through the standard handleAsCorruptDataException method to convert the supplied error condition |
| into a corrupt data exception as long as it is not present in the allow list |
| AND especially for this method, if it is not a DataUnavailable. |
| The allow list is a set of run time exceptions which must not be intercepted and must be re-thrown. |
| Typically this is where the DTFJ API allows RTE's to be thrown as well as checked exceptions. |
| Likewise, DataUnavailable is an exception that must be re-thrown and |
| not converted to CorruptDataException, hence this method's distinctive name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>p</code> - the process from the dtfj context</dd> |
| <dd><code>t</code> - the error condition to handle</dd> |
| <dt>Returns:</dt> |
| <dd>the error condition expressed as a CDE</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleAllButMemAccExAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable,java.lang.Class[])"> |
| <h3>handleAllButMemAccExAsCorruptDataException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span> <span class="element-name">handleAllButMemAccExAsCorruptDataException</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?>[] allowlist)</span> |
| throws <span class="exceptions"><a href="../../../dtfj/image/MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></span></div> |
| <div class="block">Go through the standard handleAsCorruptDataException method to convert the supplied error condition |
| into a corrupt data exception as long as it is not present in the allow list |
| AND especially for this method, if it is not a MemoryAccessException. |
| The allow list is a set of run time exceptions which must not be intercepted and must be re-thrown. |
| Typically this is where the DTFJ API allows RTE's to be thrown as well as checked exceptions. |
| Likewise, MemoryAccessException is an exception that must be re-thrown and |
| not converted to CorruptDataException, hence this method's distinctive name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>p</code> - the process from the dtfj context</dd> |
| <dd><code>t</code> - the error condition to handle</dd> |
| <dd><code>allowlist</code> - runtime exceptions which should be ignored and re-thrown</dd> |
| <dt>Returns:</dt> |
| <dd>the error condition expressed as a CDE</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../dtfj/image/MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleAllButMemAccExAndDataUnavailAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable,java.lang.Class[])"> |
| <h3>handleAllButMemAccExAndDataUnavailAsCorruptDataException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span> <span class="element-name">handleAllButMemAccExAndDataUnavailAsCorruptDataException</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?>[] allowlist)</span> |
| throws <span class="exceptions"><a href="../../../dtfj/image/MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a>, |
| <a href="../../../dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span></div> |
| <div class="block">Go through the standard handleAsCorruptDataException method to convert the supplied error condition |
| into a corrupt data exception as long as it is not present in the allow list |
| AND especially for this method, if it is neither MemoryAccessException or DataUnavailable. |
| The allow list is a set of run time exceptions which must not be intercepted and must be re-thrown. |
| Typically this is where the DTFJ API allows RTE's to be thrown as well as checked exceptions. |
| Likewise, MemoryAccessException and DataUnavailable are exceptions that must be re-thrown and |
| not converted to CorruptDataException, hence this method's distinctive name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>p</code> - the process from the dtfj context</dd> |
| <dd><code>t</code> - the error condition to handle</dd> |
| <dd><code>allowlist</code> - runtime exceptions which should be ignored and re-thrown</dd> |
| <dt>Returns:</dt> |
| <dd>the error condition expressed as a CDE</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../dtfj/image/MemoryAccessException.html" title="class in com.ibm.dtfj.image">MemoryAccessException</a></code></dd> |
| <dd><code><a href="../../../dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable,java.lang.Class[])"> |
| <h3>handleAsCorruptDataException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span> <span class="element-name">handleAsCorruptDataException</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?>[] allowlist)</span></div> |
| <div class="block">Go through the standard handleAsCorruptDataException method to convert the supplied error condition |
| into a corrupt data exception as long as it is not present in the allow list. |
| The allow list is a set of run time exceptions which must not be intercepted and must be re-thrown. |
| Typically this is where the DTFJ API allows RTE's to be thrown as well as checked exceptions.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>p</code> - the process from the dtfj context</dd> |
| <dd><code>t</code> - the error condition to handle</dd> |
| <dd><code>allowlist</code> - runtime exceptions which should be ignored and re-thrown</dd> |
| <dt>Returns:</dt> |
| <dd>the error condition expressed as a CDE</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleAsCorruptDataException(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable)"> |
| <h3>handleAsCorruptDataException</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../../../dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></span> <span class="element-name">handleAsCorruptDataException</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t)</span></div> |
| <div class="block">Convert the supplied error condition into a corrupt data exception |
| or re-throw it if it is an instance of Error that we do not want to |
| intercept.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>p</code> - the process from the DTFJ context</dd> |
| <dd><code>t</code> - error condition to convert</dd> |
| <dt>Returns:</dt> |
| <dd>CorruptDataException</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleAsCorruptData(com.ibm.j9ddr.corereaders.memory.IProcess,java.lang.Throwable)"> |
| <h3>handleAsCorruptData</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../../../dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image">CorruptData</a></span> <span class="element-name">handleAsCorruptData</span>​<span class="parameters">(<a href="../../corereaders/memory/IProcess.html" title="interface in com.ibm.j9ddr.corereaders.memory">IProcess</a> p, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t)</span></div> |
| <div class="block">Convert the supplied error condition into a CorruptData object and return |
| it, typically for insertion into an iterator, |
| or re-throw it if it is an instance of Error that we do not want to |
| intercept.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>p</code> - the process from the dtfj context</dd> |
| <dd><code>t</code> - the error condition to handle</dd> |
| <dt>Returns:</dt> |
| <dd>the error expressed as corrupt data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handleAsDataUnavailable(java.lang.Throwable)"> |
| <h3>handleAsDataUnavailable</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../../../dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></span> <span class="element-name">handleAsDataUnavailable</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link" target="_blank">Throwable</a> t)</span></div> |
| <div class="block">Handle the supplied error condition and ultimately surface it as a |
| data unavailable exception. This is required as not all API calls |
| allow a CorruptDataException to be thrown</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>t</code> - error condition to handle</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code> - ultimately throw an CDE</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 © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
