| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ValueTypeHelper (OpenJ9 JDK 17)</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.vm29.pointer.helper, class: ValueTypeHelper"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.j9ddr.vm29.pointer.helper.ValueTypeHelper class"> |
| <meta name="keywords" content="logger"> |
| <meta name="keywords" content="getValueTypeHelper()"> |
| <meta name="keywords" content="areValueTypesSupported()"> |
| <meta name="keywords" content="findJ9ClassInFlattenedClassCacheWithFieldName()"> |
| <meta name="keywords" content="findNestedClassHierarchy()"> |
| <meta name="keywords" content="findJ9ClassInFlattenedClassCacheWithSigName()"> |
| <meta name="keywords" content="isRomClassAValueType()"> |
| <meta name="keywords" content="doesRomClassPermitsValue()"> |
| <meta name="keywords" content="isJ9ClassAValueType()"> |
| <meta name="keywords" content="isJ9ClassAPrimitiveValueType()"> |
| <meta name="keywords" content="isFieldInClassFlattened()"> |
| <meta name="keywords" content="isFlattenableFieldSignature()"> |
| <meta name="keywords" content="isJ9ClassLargestAlignmentConstraintDouble()"> |
| <meta name="keywords" content="isJ9ClassLargestAlignmentConstraintReference()"> |
| <meta name="keywords" content="isJ9ClassIsFlattened()"> |
| <meta name="keywords" content="isJ9FieldIsFlattened()"> |
| <meta name="keywords" content="classRequires4BytePrePadding()"> |
| <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 17</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/ValueTypeHelper.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" 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.vm29.pointer.helper</a></div> |
| <h1 title="Class ValueTypeHelper" class="title">Class ValueTypeHelper</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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.vm29.pointer.helper.ValueTypeHelper</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ValueTypeHelper</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span></div> |
| <div class="block">Value type helper class |
| |
| areValueTypesSupported() must return true before using any other methods in this class</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.logging/java/util/logging/Logger.html" title="class or interface in java.util.logging" class="external-link" target="_blank">Logger</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#logger" class="member-name-link">logger</a></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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></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 method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#areValueTypesSupported()" class="member-name-link">areValueTypesSupported</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if the JVM that produced the core file supports value types.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#classRequires4BytePrePadding(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)" class="member-name-link">classRequires4BytePrePadding</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if class is has 4byte pre-padding in the stand-alone case</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doesRomClassPermitsValue(com.ibm.j9ddr.vm29.pointer.generated.J9ROMClassPointer)" class="member-name-link">doesRomClassPermitsValue</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ROMClassPointer romClass)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if a J9ROMClass can be extended by a value class</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findJ9ClassInFlattenedClassCacheWithFieldName(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,java.lang.String)" class="member-name-link">findJ9ClassInFlattenedClassCacheWithFieldName</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fieldName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Searches the flattenedClassCache (FCC) for a J9Class given a field name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findJ9ClassInFlattenedClassCacheWithSigName(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,java.lang.String)" class="member-name-link">findJ9ClassInFlattenedClassCacheWithSigName</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fieldSig)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Searches the flattenedClassCache (FCC) for a J9Class given a field signature.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findNestedClassHierarchy(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,java.lang.String%5B%5D)" class="member-name-link">findNestedClassHierarchy</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer containerClazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[] nestingHierarchy)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an array of J9ClassPointers that contains the containerClazz passed in addition to the J9ClassPointers |
| that correspond to the types of the field names passed in the nestingHierarchy array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ValueTypeHelper.html" title="class in com.ibm.j9ddr.vm29.pointer.helper">ValueTypeHelper</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getValueTypeHelper()" class="member-name-link">getValueTypeHelper</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Factory method that returns a valueTypeHelper instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFieldInClassFlattened(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,com.ibm.j9ddr.vm29.pointer.generated.J9ROMFieldShapePointer)" class="member-name-link">isFieldInClassFlattened</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz, |
| com.ibm.j9ddr.vm29.pointer.generated.J9ROMFieldShapePointer fieldShape)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries whether field is flattened of not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFlattenableFieldSignature(java.lang.String)" class="member-name-link">isFlattenableFieldSignature</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> signature)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if field signature is flattenable</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isJ9ClassAPrimitiveValueType(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)" class="member-name-link">isJ9ClassAPrimitiveValueType</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if J9Class is a primitive value type</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isJ9ClassAValueType(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)" class="member-name-link">isJ9ClassAValueType</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if J9Class is a value type</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isJ9ClassIsFlattened(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)" class="member-name-link">isJ9ClassIsFlattened</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if class is flattened</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isJ9ClassLargestAlignmentConstraintDouble(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)" class="member-name-link">isJ9ClassLargestAlignmentConstraintDouble</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if class contains a field with a double (64 bit) alignment constraint</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isJ9ClassLargestAlignmentConstraintReference(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)" class="member-name-link">isJ9ClassLargestAlignmentConstraintReference</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if class contains a field with a reference alignment constraint</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isJ9FieldIsFlattened(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,com.ibm.j9ddr.vm29.pointer.generated.J9ROMFieldShapePointer)" class="member-name-link">isJ9FieldIsFlattened</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer fieldClazz, |
| com.ibm.j9ddr.vm29.pointer.generated.J9ROMFieldShapePointer fieldShape)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if a field in a class is flattened</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRomClassAValueType(com.ibm.j9ddr.vm29.pointer.generated.J9ROMClassPointer)" class="member-name-link">isRomClassAValueType</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ROMClassPointer romClass)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Queries if J9ROMClass is a value type</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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="logger"> |
| <h3>logger</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.logging/java/util/logging/Logger.html" title="class or interface in java.util.logging" class="external-link" target="_blank">Logger</a></span> <span class="element-name">logger</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="getValueTypeHelper()"> |
| <h3>getValueTypeHelper</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ValueTypeHelper.html" title="class in com.ibm.j9ddr.vm29.pointer.helper">ValueTypeHelper</a></span> <span class="element-name">getValueTypeHelper</span>()</div> |
| <div class="block">Factory method that returns a valueTypeHelper instance.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>valueTypeHelper</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="areValueTypesSupported()"> |
| <h3>areValueTypesSupported</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">areValueTypesSupported</span>()</div> |
| <div class="block">Queries if the JVM that produced the core file supports value types. This |
| must be called before any other ValueTypeHelper functions are called.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if value types are supported, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findJ9ClassInFlattenedClassCacheWithFieldName(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,java.lang.String)"> |
| <h3>findJ9ClassInFlattenedClassCacheWithFieldName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer</span> <span class="element-name">findJ9ClassInFlattenedClassCacheWithFieldName</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fieldName)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Searches the flattenedClassCache (FCC) for a J9Class given a field name. |
| areValueTypesSupported() must return true before using this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - J9Class pointer that owns the FCC to be searched</dd> |
| <dd><code>fieldName</code> - name of the field to lookup in the FCC</dd> |
| <dt>Returns:</dt> |
| <dd>J9Class of the fieldName if found, J9ClassPointer.NULL otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findNestedClassHierarchy(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,java.lang.String[])"> |
| <h3>findNestedClassHierarchy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer[]</span> <span class="element-name">findNestedClassHierarchy</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer containerClazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[] nestingHierarchy)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Returns an array of J9ClassPointers that contains the containerClazz passed in addition to the J9ClassPointers |
| that correspond to the types of the field names passed in the nestingHierarchy array. Each subsequent |
| field name in the nestingHierarchy array is a nested field of the previous element. For example |
| nestingHierarchy[1] is a member of nestingHierarchy[0], and nestingHierarchy[2] is a member of |
| nestingHierarchy[1]. nestingHierarchy[0] is the first nested member in the containerClazz. The resulting array contains |
| at least one element (containerClazz). |
| |
| areValueTypesSupported() must return true before using this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>containerClazz</code> - type that contains all the nested members</dd> |
| <dd><code>nestingHierarchy</code> - array that contains field names for nested members. Must be non-NULL</dd> |
| <dt>Returns:</dt> |
| <dd>an array containing at least the containerClazz, and J9ClassPointer's corresponding to the names passed in the nestingHierarchy</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findJ9ClassInFlattenedClassCacheWithSigName(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,java.lang.String)"> |
| <h3>findJ9ClassInFlattenedClassCacheWithSigName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer</span> <span class="element-name">findJ9ClassInFlattenedClassCacheWithSigName</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fieldSig)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Searches the flattenedClassCache (FCC) for a J9Class given a field signature. |
| areValueTypesSupported() must return true before using this method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - J9Class pointer that owns the FCC to be searched</dd> |
| <dd><code>fieldSig</code> - signature to lookup in the FCC</dd> |
| <dt>Returns:</dt> |
| <dd>J9ClassPointer corresponding to the signature if found, J9ClassPointer.NULL otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRomClassAValueType(com.ibm.j9ddr.vm29.pointer.generated.J9ROMClassPointer)"> |
| <h3>isRomClassAValueType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRomClassAValueType</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ROMClassPointer romClass)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if J9ROMClass is a value type</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>romClass</code> - clazz to query</dd> |
| <dt>Returns:</dt> |
| <dd>true if romClass is a value type, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doesRomClassPermitsValue(com.ibm.j9ddr.vm29.pointer.generated.J9ROMClassPointer)"> |
| <h3>doesRomClassPermitsValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">doesRomClassPermitsValue</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ROMClassPointer romClass)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if a J9ROMClass can be extended by a value class</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>romClass</code> - class to query</dd> |
| <dt>Returns:</dt> |
| <dd>true if the romClass is atomic, false otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isJ9ClassAValueType(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)"> |
| <h3>isJ9ClassAValueType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isJ9ClassAValueType</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if J9Class is a value type</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - clazz to query</dd> |
| <dt>Returns:</dt> |
| <dd>true if class is a value type, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isJ9ClassAPrimitiveValueType(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)"> |
| <h3>isJ9ClassAPrimitiveValueType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isJ9ClassAPrimitiveValueType</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if J9Class is a primitive value type</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - clazz to query</dd> |
| <dt>Returns:</dt> |
| <dd>true if class is a primitive value type, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFieldInClassFlattened(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,com.ibm.j9ddr.vm29.pointer.generated.J9ROMFieldShapePointer)"> |
| <h3>isFieldInClassFlattened</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFieldInClassFlattened</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz, |
| com.ibm.j9ddr.vm29.pointer.generated.J9ROMFieldShapePointer fieldShape)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries whether field is flattened of not.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - clazz containing the field</dd> |
| <dd><code>fieldShape</code> - J9ROMFieldShapePointer</dd> |
| <dt>Returns:</dt> |
| <dd>true if field is flattened, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFlattenableFieldSignature(java.lang.String)"> |
| <h3>isFlattenableFieldSignature</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFlattenableFieldSignature</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> signature)</span></div> |
| <div class="block">Queries if field signature is flattenable</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>signature</code> - field signature</dd> |
| <dt>Returns:</dt> |
| <dd>true if field signature is flattenable, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isJ9ClassLargestAlignmentConstraintDouble(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)"> |
| <h3>isJ9ClassLargestAlignmentConstraintDouble</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isJ9ClassLargestAlignmentConstraintDouble</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if class contains a field with a double (64 bit) alignment constraint</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - J9Class</dd> |
| <dt>Returns:</dt> |
| <dd>true if clazz has double alignment constraint, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isJ9ClassLargestAlignmentConstraintReference(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)"> |
| <h3>isJ9ClassLargestAlignmentConstraintReference</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isJ9ClassLargestAlignmentConstraintReference</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if class contains a field with a reference alignment constraint</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - J9Class</dd> |
| <dt>Returns:</dt> |
| <dd>true if clazz has reference alignment constraint, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isJ9ClassIsFlattened(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)"> |
| <h3>isJ9ClassIsFlattened</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isJ9ClassIsFlattened</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if class is flattened</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - J9Class</dd> |
| <dt>Returns:</dt> |
| <dd>true if clazz is flattened, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isJ9FieldIsFlattened(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer,com.ibm.j9ddr.vm29.pointer.generated.J9ROMFieldShapePointer)"> |
| <h3>isJ9FieldIsFlattened</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isJ9FieldIsFlattened</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer fieldClazz, |
| com.ibm.j9ddr.vm29.pointer.generated.J9ROMFieldShapePointer fieldShape)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if a field in a class is flattened</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fieldClazz</code> - J9Class of the field</dd> |
| <dd><code>fieldShape</code> - J9ROMFieldShapePointer</dd> |
| <dt>Returns:</dt> |
| <dd>true if the field is flattened, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="classRequires4BytePrePadding(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)"> |
| <h3>classRequires4BytePrePadding</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">classRequires4BytePrePadding</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer clazz)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Queries if class is has 4byte pre-padding in the stand-alone case</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - J9Class</dd> |
| <dt>Returns:</dt> |
| <dd>true if clazz is requires pre-padding, false otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></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, 2022 IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |