| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>GCHeapRegionDescriptorSegregated_V1 (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: GCHeapRegionDescriptorSegregated_V1"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.j9ddr.vm29.j9.gc.GCHeapRegionDescriptorSegregated_V1 class"> |
| <meta name="keywords" content="sizeClass"> |
| <meta name="keywords" content="cellSize"> |
| <meta name="keywords" content="getSizeClass()"> |
| <meta name="keywords" content="getCellSize()"> |
| <meta name="keywords" content="objectIterator()"> |
| <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/GCHeapRegionDescriptorSegregated_V1.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.j9ddr.vm29.j9.gc</a></div> |
| <h1 title="Class GCHeapRegionDescriptorSegregated_V1" class="title">Class GCHeapRegionDescriptorSegregated_V1</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="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">com.ibm.j9ddr.vm29.j9.gc.GCHeapRegionDescriptor</a> |
| <div class="inheritance">com.ibm.j9ddr.vm29.j9.gc.GCHeapRegionDescriptorSegregated_V1</div> |
| </div> |
| </div> |
| <section class="description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">GCHeapRegionDescriptorSegregated_V1</span> |
| <span class="extends-implements">extends <a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</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 <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#cellSize">cellSize</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#headOfSpan">headOfSpan</a></span></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#highAddress">highAddress</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#lowAddress">lowAddress</a></span></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected com.ibm.j9ddr.vm29.pointer.generated.MM_MemoryPoolPointer</code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#memoryPool">memoryPool</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySubSpacePointer</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#memorySubSpace">memorySubSpace</a></span></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#regionsInSpan">regionsInSpan</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected long</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#regionType">regionType</a></span></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#sizeClass">sizeClass</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#typeFlags">typeFlags</a></span></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields.inherited.from.class.com.ibm.j9ddr.vm29.j9.gc.GCHeapRegionDescriptor">Fields declared in class com.ibm.j9ddr.vm29.j9.gc.<a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></h3> |
| <code><a href="GCHeapRegionDescriptor.html#heapRegionDescriptor">heapRegionDescriptor</a></code></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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorSegregatedPointer)">GCHeapRegionDescriptorSegregated_V1</a></span>​(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorSegregatedPointer region)</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-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-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#containsObjects()">containsObjects</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></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="#descriptionString()">descriptionString</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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="#getCellSize()">getCellSize</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</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="#getHeadOfSpan()">getHeadOfSpan</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><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-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getHighAddress()">getHighAddress</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Get the high address of this region</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</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="#getLowAddress()">getLowAddress</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Get the low address of this region</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>com.ibm.j9ddr.vm29.pointer.generated.MM_MemoryPoolPointer</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="#getMemoryPool()">getMemoryPool</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</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="#getRegionType()">getRegionType</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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="#getSize()">getSize</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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="#getSizeClass()">getSizeClass</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySubSpacePointer</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="#getSubSpace()">getSubSpace</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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="#getTypeFlags()">getTypeFlags</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">A helper to request the type flags from the Subspace associated with the receiving region.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected <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-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getWalkableHighAddress()">getWalkableHighAddress</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#hasValidMarkMap()">hasValidMarkMap</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected void</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="#init()">init</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#isAddressInRegion(com.ibm.j9ddr.vm29.pointer.AbstractPointer)">isAddressInRegion</a></span>​(<a href="../../pointer/AbstractPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">AbstractPointer</a> address)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Determine if the specified address is in the region</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#isImmortal()">isImmortal</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#isScoped()">isScoped</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="GCObjectHeapIterator.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCObjectHeapIterator</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="#objectIterator(boolean,boolean)">objectIterator</a></span>​(boolean includeLiveObjects, |
| boolean includeDeadObjects)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Create an iterator which iterates over all objects (if any) in the region</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.com.ibm.j9ddr.vm29.j9.gc.GCHeapRegionDescriptor">Methods declared in class com.ibm.j9ddr.vm29.j9.gc.<a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></h3> |
| <code><a href="GCHeapRegionDescriptor.html#fromHeapRegionDescriptor(com.ibm.j9ddr.vm29.j9.gc.GCHeapRegionDescriptor)">fromHeapRegionDescriptor</a>, <a href="GCHeapRegionDescriptor.html#fromHeapRegionDescriptor(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorPointer)">fromHeapRegionDescriptor</a>, <a href="GCHeapRegionDescriptor.html#getHeapRegionDescriptorPointer()">getHeapRegionDescriptorPointer</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field.detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="sizeClass"> |
| <h3>sizeClass</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">sizeClass</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cellSize"> |
| <h3>cellSize</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">cellSize</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lowAddress"> |
| <h3>lowAddress</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">lowAddress</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="highAddress"> |
| <h3>highAddress</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">highAddress</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="regionsInSpan"> |
| <h3>regionsInSpan</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">regionsInSpan</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="regionType"> |
| <h3>regionType</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name">regionType</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="typeFlags"> |
| <h3>typeFlags</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">typeFlags</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="memorySubSpace"> |
| <h3>memorySubSpace</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySubSpacePointer</span> <span class="element-name">memorySubSpace</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="memoryPool"> |
| <h3>memoryPool</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.MM_MemoryPoolPointer</span> <span class="element-name">memoryPool</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="headOfSpan"> |
| <h3>headOfSpan</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></span> <span class="element-name">headOfSpan</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="<init>(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorSegregatedPointer)"> |
| <h3>GCHeapRegionDescriptorSegregated_V1</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GCHeapRegionDescriptorSegregated_V1</span>​<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapRegionDescriptorSegregatedPointer region)</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="getSizeClass()"> |
| <h3>getSizeClass</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">getSizeClass</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCellSize()"> |
| <h3>getCellSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">getCellSize</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="objectIterator(boolean,boolean)"> |
| <h3>objectIterator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GCObjectHeapIterator.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCObjectHeapIterator</a></span> <span class="element-name">objectIterator</span>​<span class="parameters">(boolean includeLiveObjects, |
| boolean includeDeadObjects)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="GCHeapRegionDescriptor.html#objectIterator(boolean,boolean)">GCHeapRegionDescriptor</a></code></span></div> |
| <div class="block">Create an iterator which iterates over all objects (if any) in the region</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an GCObjectHeapIterator which iterates over all objects in the region</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="init()"> |
| <h3>init</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">init</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="getLowAddress()"> |
| <h3>getLowAddress</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">getLowAddress</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="GCHeapRegionDescriptor.html#getLowAddress()">GCHeapRegionDescriptor</a></code></span></div> |
| <div class="block">Get the low address of this region</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#getLowAddress()">getLowAddress</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the lowest address in the region</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHighAddress()"> |
| <h3>getHighAddress</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">getHighAddress</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="GCHeapRegionDescriptor.html#getHighAddress()">GCHeapRegionDescriptor</a></code></span></div> |
| <div class="block">Get the high address of this region</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#getHighAddress()">getHighAddress</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the first address beyond the end of the region</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSize()"> |
| <h3>getSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">getSize</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#getSize()">getSize</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The number of contiguous bytes represented by the receiver</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTypeFlags()"> |
| <h3>getTypeFlags</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">getTypeFlags</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="GCHeapRegionDescriptor.html#getTypeFlags()">GCHeapRegionDescriptor</a></code></span></div> |
| <div class="block">A helper to request the type flags from the Subspace associated with the receiving region.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#getTypeFlags()">getTypeFlags</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The type flags of the Subspace associated with this region</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasValidMarkMap()"> |
| <h3>hasValidMarkMap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasValidMarkMap</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#hasValidMarkMap()">hasValidMarkMap</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the region has an up-to-date mark map</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsObjects()"> |
| <h3>containsObjects</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">containsObjects</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#containsObjects()">containsObjects</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the region contains objects</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWalkableHighAddress()"> |
| <h3>getWalkableHighAddress</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">getWalkableHighAddress</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="getRegionType()"> |
| <h3>getRegionType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getRegionType</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#getRegionType()">getRegionType</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>this region's current type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubSpace()"> |
| <h3>getSubSpace</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.MM_MemorySubSpacePointer</span> <span class="element-name">getSubSpace</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#getSubSpace()">getSubSpace</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the memory subspace associated with this region</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemoryPool()"> |
| <h3>getMemoryPool</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.MM_MemoryPoolPointer</span> <span class="element-name">getMemoryPool</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#getMemoryPool()">getMemoryPool</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the memory subspace associated with this region</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAddressInRegion(com.ibm.j9ddr.vm29.pointer.AbstractPointer)"> |
| <h3>isAddressInRegion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAddressInRegion</span>​<span class="parameters">(<a href="../../pointer/AbstractPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">AbstractPointer</a> address)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="GCHeapRegionDescriptor.html#isAddressInRegion(com.ibm.j9ddr.vm29.pointer.AbstractPointer)">GCHeapRegionDescriptor</a></code></span></div> |
| <div class="block">Determine if the specified address is in the region</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#isAddressInRegion(com.ibm.j9ddr.vm29.pointer.AbstractPointer)">isAddressInRegion</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if address is within the receiver, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isImmortal()"> |
| <h3>isImmortal</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isImmortal</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#isImmortal()">isImmortal</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the region is associated with a subspace with immortal memory type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isScoped()"> |
| <h3>isScoped</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isScoped</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#isScoped()">isScoped</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the region is associated with a subspace with scoped memory type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeadOfSpan()"> |
| <h3>getHeadOfSpan</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></span> <span class="element-name">getHeadOfSpan</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="GCHeapRegionDescriptor.html#getHeadOfSpan()">getHeadOfSpan</a></code> in class <code><a href="GCHeapRegionDescriptor.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapRegionDescriptor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>in a spanning region, return to the HEAD of the span; in non-spanning region return this</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="descriptionString()"> |
| <h3>descriptionString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">descriptionString</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
