blob: f5ef2136d8abca49f08cb9f5ae2a4f138ffd5a41 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>GCObjectModel (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.vm29.j9.gc, class: GCObjectModel">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.j9ddr.vm29.j9.gc.GCObjectModel class">
<meta name="keywords" content="mixedObjectModel">
<meta name="keywords" content="indexableObjectModel">
<meta name="keywords" content="from()">
<meta name="keywords" content="adjustSizeInBytes()">
<meta name="keywords" content="getClassShape()">
<meta name="keywords" content="isIndexable()">
<meta name="keywords" content="isDeadObject()">
<meta name="keywords" content="isSingleSlotDeadObject()">
<meta name="keywords" content="getSizeInBytesMultiSlotDeadObject()">
<meta name="keywords" content="getSizeInBytesSingleSlotDeadObject()">
<meta name="keywords" content="getObjectAlignmentInBytes()">
<meta name="keywords" content="getSizeInBytesDeadObject()">
<meta name="keywords" content="getSizeInBytesWithHeader()">
<meta name="keywords" content="getTotalFootprintInBytesWithHeader()">
<meta name="keywords" content="getConsumedSizeInBytesWithHeader()">
<meta name="keywords" content="getSizeInSlotsWithHeader()">
<meta name="keywords" content="getConsumedSizeInSlotsWithHeader()">
<meta name="keywords" content="getAge()">
<meta name="keywords" content="isRemembered()">
<meta name="keywords" content="getRememberedBits()">
<meta name="keywords" content="isOld()">
<meta name="keywords" content="getSizeInElements()">
<meta name="keywords" content="getScanType()">
<meta name="keywords" content="hasBeenHashed()">
<meta name="keywords" content="hasBeenMoved()">
<meta name="keywords" content="getObjectHashCode()">
<meta name="keywords" content="getHashcodeOffset()">
<meta name="keywords" content="getDataSizeInBytes()">
<meta name="keywords" content="getHeaderSize()">
<meta name="keywords" content="getElementAddress()">
<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/GCObjectModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../../module-summary.html">openj9.dtfj</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.j9ddr.vm29.j9.gc</a></div>
<h1 title="Class GCObjectModel" class="title">Class GCObjectModel</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"><a href="GCBase.html" title="class in com.ibm.j9ddr.vm29.j9.gc">com.ibm.j9ddr.vm29.j9.gc.GCBase</a>
<div class="inheritance">com.ibm.j9ddr.vm29.j9.gc.GCObjectModel</div>
</div>
</div>
<section class="description">
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">GCObjectModel</span>
<span class="extends-implements">extends <a href="GCBase.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCBase</a></span></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 com.ibm.j9ddr.vm29.j9.gc.GCArrayObjectModel</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#indexableObjectModel">indexableObjectModel</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected com.ibm.j9ddr.vm29.j9.gc.GCMixedObjectModel</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#mixedObjectModel">mixedObjectModel</a></span></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== 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 three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E()">GCObjectModel</a></span>()</code></div>
<div class="col-last even-row-color">&nbsp;</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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#adjustSizeInBytes(com.ibm.j9ddr.vm29.types.UDATA)">adjustSizeInBytes</a></span>&#8203;(<a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a>&nbsp;sizeInBytes)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Object size should be at least minimumConsumedSize
and 8 byte aligned.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="GCObjectModel.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCObjectModel</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="#from()">from</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Factory method to construct an appropriate object model.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/U32.html" title="class in com.ibm.j9ddr.vm29.types">U32</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getAge(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getAge</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the age of an object.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getClassShape(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)">getClassShape</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer&nbsp;clazz)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the shape of a class.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getClassShape(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getClassShape</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the shape of an object.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getConsumedSizeInBytesWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getConsumedSizeInBytesWithHeader</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Same as getSizeInBytesWithHeader,
except it takes into account
object alignment and minimum object size</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getConsumedSizeInSlotsWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getConsumedSizeInSlotsWithHeader</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Same as getSizeInSlotsWithHeader,
except it takes into account
object alignment and minimum object size</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getDataSizeInBytes(com.ibm.j9ddr.vm29.pointer.generated.J9IndexableObjectPointer)">getDataSizeInBytes</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9IndexableObjectPointer&nbsp;array)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns the size of data in an indexable object, in bytes, including leaves, excluding the header.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getElementAddress(com.ibm.j9ddr.vm29.pointer.generated.J9IndexableObjectPointer,int,int)">getElementAddress</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9IndexableObjectPointer&nbsp;indexableObjectPointer,
int&nbsp;elementIndex,
int&nbsp;elementSize)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the address of the element at elementIndex logical offset into indexableObjectPointer, assuming that each
element is dataSize bytes.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getHashcodeOffset(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getHashcodeOffset</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getHeaderSize(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getHeaderSize</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the size of an object header, in bytes.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract long</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getObjectAlignmentInBytes()">getObjectAlignmentInBytes</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns run-time object alignment in bytes.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/I32.html" title="class in com.ibm.j9ddr.vm29.types">I32</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getObjectHashCode(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getObjectHashCode</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Determine the basic hash code for the specified object.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getRememberedBits(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getRememberedBits</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the collector bits from object's header.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract long</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getScanType(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getScanType</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSizeInBytesDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getSizeInBytesDeadObject</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the size in bytes of a dead object.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSizeInBytesMultiSlotDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getSizeInBytesMultiSlotDeadObject</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the size, in bytes, of a multi-slot dead object.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSizeInBytesSingleSlotDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getSizeInBytesSingleSlotDeadObject</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the size, in bytes, of a single slot dead object.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSizeInBytesWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getSizeInBytesWithHeader</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the size of an object, in bytes, including the header.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSizeInElements(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getSizeInElements</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the size of an indexable object in elements.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getSizeInSlotsWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getSizeInSlotsWithHeader</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns the size of an object, in slots, including the header.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getTotalFootprintInBytesWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">getTotalFootprintInBytesWithHeader</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Get the total footprint of an object, in bytes, including the object header and all data.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#hasBeenHashed(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">hasBeenHashed</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns TRUE if an object has been hashed, FALSE otherwise.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#hasBeenMoved(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">hasBeenMoved</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns TRUE if an object has been moved after being hashed, FALSE otherwise.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#isDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">isDeadObject</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns TRUE if an object is dead, FALSE otherwise.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#isIndexable(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)">isIndexable</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer&nbsp;clazz)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns TRUE if an class is indexable, FALSE otherwise.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#isIndexable(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">isIndexable</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns TRUE if an object is indexable, FALSE otherwise.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#isOld(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">isOld</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns TRUE if an object is old, FALSE otherwise.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#isRemembered(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">isRemembered</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns TRUE if an object is remembered, FALSE otherwise.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#isSingleSlotDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">isSingleSlotDeadObject</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns TRUE if an object is a dead single slot object, FALSE otherwise.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.j9ddr.vm29.j9.gc.GCBase">Methods declared in class&nbsp;com.ibm.j9ddr.vm29.j9.gc.<a href="GCBase.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCBase</a></h3>
<code><a href="GCBase.html#getExtensions()">getExtensions</a>, <a href="GCBase.html#getJavaVM()">getJavaVM</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field.detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="mixedObjectModel">
<h3>mixedObjectModel</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">com.ibm.j9ddr.vm29.j9.gc.GCMixedObjectModel</span>&nbsp;<span class="element-name">mixedObjectModel</span></div>
</section>
</li>
<li>
<section class="detail" id="indexableObjectModel">
<h3>indexableObjectModel</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">com.ibm.j9ddr.vm29.j9.gc.GCArrayObjectModel</span>&nbsp;<span class="element-name">indexableObjectModel</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>GCObjectModel</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">GCObjectModel</span>()
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<dl class="notes">
<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>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="from()">
<h3>from</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="GCObjectModel.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCObjectModel</a></span>&nbsp;<span class="element-name">from</span>()
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Factory method to construct an appropriate object model.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>structure</code> - the J9JavaVM structure to use</dd>
<dt>Returns:</dt>
<dd>an instance of ObjectModel</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="adjustSizeInBytes(com.ibm.j9ddr.vm29.types.UDATA)">
<h3>adjustSizeInBytes</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">adjustSizeInBytes</span>&#8203;<span class="parameters">(<a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a>&nbsp;sizeInBytes)</span></div>
<div class="block">Object size should be at least minimumConsumedSize
and 8 byte aligned.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>sizeInBytes</code> - Real size of an object</dd>
<dt>Returns:</dt>
<dd>Adjusted size</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getClassShape(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getClassShape</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getClassShape</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the shape of an object.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to object whose shape is required.</dd>
<dt>Returns:</dt>
<dd>The shape of the object</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="getClassShape(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)">
<h3>getClassShape</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getClassShape</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer&nbsp;clazz)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the shape of a class.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to J9Object whose shape is required.</dd>
<dt>Returns:</dt>
<dd>The shape of the class</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="isIndexable(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>isIndexable</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isIndexable</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns TRUE if an object is indexable, FALSE otherwise.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>TRUE if an object is indexable, 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="isIndexable(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer)">
<h3>isIndexable</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isIndexable</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ClassPointer&nbsp;clazz)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns TRUE if an class is indexable, FALSE otherwise.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>clazz</code> - Pointer to an J9Class</dd>
<dt>Returns:</dt>
<dd>TRUE if an class is indexable, 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="isDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>isDeadObject</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isDeadObject</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns TRUE if an object is dead, FALSE otherwise.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>TRUE if an object is dead, 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="isSingleSlotDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>isSingleSlotDeadObject</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isSingleSlotDeadObject</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns TRUE if an object is a dead single slot object, FALSE otherwise.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>TRUE if an object is a dead single slot object, 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="getSizeInBytesMultiSlotDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getSizeInBytesMultiSlotDeadObject</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getSizeInBytesMultiSlotDeadObject</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the size, in bytes, of a multi-slot dead object.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The size, in bytes, of a multi-slot dead object</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="getSizeInBytesSingleSlotDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getSizeInBytesSingleSlotDeadObject</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getSizeInBytesSingleSlotDeadObject</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span></div>
<div class="block">Returns the size, in bytes, of a single slot dead object.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The size, in bytes, of a single slot dead object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getObjectAlignmentInBytes()">
<h3>getObjectAlignmentInBytes</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getObjectAlignmentInBytes</span>()</div>
<div class="block">Returns run-time object alignment in bytes.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The alignment in bytes</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSizeInBytesDeadObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getSizeInBytesDeadObject</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getSizeInBytesDeadObject</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the size in bytes of a dead object.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The size in bytes of a dead object</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="getSizeInBytesWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getSizeInBytesWithHeader</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getSizeInBytesWithHeader</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the size of an object, in bytes, including the header.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The size of an object, in bytes, including the header</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="getTotalFootprintInBytesWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getTotalFootprintInBytesWithHeader</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getTotalFootprintInBytesWithHeader</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Get the total footprint of an object, in bytes, including the object header and all data.
If the object has a discontiguous representation, this method should return the size of
the root object plus the total of all the discontiguous parts of the object.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>object</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>the total size of an object, in bytes, including discontiguous parts</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="getConsumedSizeInBytesWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getConsumedSizeInBytesWithHeader</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getConsumedSizeInBytesWithHeader</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Same as getSizeInBytesWithHeader,
except it takes into account
object alignment and minimum object size</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The consumed heap size of an object, in bytes, including the header</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="getSizeInSlotsWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getSizeInSlotsWithHeader</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getSizeInSlotsWithHeader</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the size of an object, in slots, including the header.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The size of an object, in slots, including the header</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="getConsumedSizeInSlotsWithHeader(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getConsumedSizeInSlotsWithHeader</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getConsumedSizeInSlotsWithHeader</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Same as getSizeInSlotsWithHeader,
except it takes into account
object alignment and minimum object size</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The consumed heap size of an object, in slots, including the header</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="getAge(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getAge</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/U32.html" title="class in com.ibm.j9ddr.vm29.types">U32</a></span>&nbsp;<span class="element-name">getAge</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the age of an object.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The age of the object</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="isRemembered(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>isRemembered</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isRemembered</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns TRUE if an object is remembered, FALSE otherwise.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>TRUE if an object is remembered, 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="getRememberedBits(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getRememberedBits</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getRememberedBits</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the collector bits from object's header.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>collector bits</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="isOld(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>isOld</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isOld</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns TRUE if an object is old, FALSE otherwise.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>TRUE if an object is in the old area, 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="getSizeInElements(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getSizeInElements</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getSizeInElements</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a>,
<a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the size of an indexable object in elements.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>array</code> - Pointer to the indexable object whose size is required</dd>
<dt>Returns:</dt>
<dd>Size of object in elements</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if the object is not an array</dd>
<dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getScanType(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getScanType</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">getScanType</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<dl class="notes">
<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="hasBeenHashed(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>hasBeenHashed</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasBeenHashed</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns TRUE if an object has been hashed, FALSE otherwise.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>TRUE if an object has been hashed, 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="hasBeenMoved(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>hasBeenMoved</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasBeenMoved</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns TRUE if an object has been moved after being hashed, FALSE otherwise.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>TRUE if an object has been moved after being hashed, 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="getObjectHashCode(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getObjectHashCode</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/I32.html" title="class in com.ibm.j9ddr.vm29.types">I32</a></span>&nbsp;<span class="element-name">getObjectHashCode</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Determine the basic hash code for the specified object.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>object</code> - [in] the object to be hashed</dd>
<dt>Returns:</dt>
<dd>the persistent, basic hash code for the object</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="getHashcodeOffset(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getHashcodeOffset</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getHashcodeOffset</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<dl class="notes">
<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="getDataSizeInBytes(com.ibm.j9ddr.vm29.pointer.generated.J9IndexableObjectPointer)">
<h3>getDataSizeInBytes</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getDataSizeInBytes</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9IndexableObjectPointer&nbsp;array)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the size of data in an indexable object, in bytes, including leaves, excluding the header.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>array</code> - Pointer to the indexable object whose size is required</dd>
<dt>Returns:</dt>
<dd>The size of an object in bytes excluding the header</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="getHeaderSize(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)">
<h3>getHeaderSize</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span>&nbsp;<span class="element-name">getHeaderSize</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer&nbsp;object)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the size of an object header, in bytes.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>objectPtr</code> - Pointer to an object</dd>
<dt>Returns:</dt>
<dd>The size of an object header, in bytes.</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="getElementAddress(com.ibm.j9ddr.vm29.pointer.generated.J9IndexableObjectPointer,int,int)">
<h3>getElementAddress</h3>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span>&nbsp;<span class="element-name">getElementAddress</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9IndexableObjectPointer&nbsp;indexableObjectPointer,
int&nbsp;elementIndex,
int&nbsp;elementSize)</span>
throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Returns the address of the element at elementIndex logical offset into indexableObjectPointer, assuming that each
element is dataSize bytes.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>indexableObjectPointer</code> - The array from which we should look-up the address</dd>
<dd><code>elementIndex</code> - The logical index number of the element within the array</dd>
<dd><code>elementSize</code> - The size, in bytes, of a single element of the array</dd>
<dt>Returns:</dt>
<dd>A pointer to the element</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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>