blob: 7333833db9ee302b6cd4961a87e995e4e9d7e4bc [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>ModuleHashTable (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, class: ModuleHashTable">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.j9ddr.vm29.j9.ModuleHashTable class">
<meta name="keywords" content="fromJ9HashTable()">
<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/ModuleHashTable.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><a href="#nested.class.summary">Nested</a>&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>Field&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</a></div>
<h1 title="Class ModuleHashTable" class="title">Class ModuleHashTable</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="HashTable.html" title="class in com.ibm.j9ddr.vm29.j9">com.ibm.j9ddr.vm29.j9.HashTable</a>&lt;StructType&gt;
<div class="inheritance"><a href="HashTable_V1.html" title="class in com.ibm.j9ddr.vm29.j9">com.ibm.j9ddr.vm29.j9.HashTable_V1</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;
<div class="inheritance">com.ibm.j9ddr.vm29.j9.ModuleHashTable</div>
</div>
</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="IHashTable.html" title="interface in com.ibm.j9ddr.vm29.j9">IHashTable</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ModuleHashTable</span>
<span class="extends-implements">extends <a href="HashTable_V1.html" title="class in com.ibm.j9ddr.vm29.j9">HashTable_V1</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;</span></div>
<div class="block">ModuleHashTable is used for accessing hash tables in J9Modules (e.g. readAccessHashTable)</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested.class.summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested.classes.inherited.from.class.com.ibm.j9ddr.vm29.j9.HashTable">Nested classes/interfaces declared in class&nbsp;com.ibm.j9ddr.vm29.j9.<a href="HashTable.html" title="class in com.ibm.j9ddr.vm29.j9">HashTable</a></h2>
<code><a href="HashTable.HashEqualFunction.html" title="interface in com.ibm.j9ddr.vm29.j9">HashTable.HashEqualFunction</a>&lt;<a href="HashTable.HashEqualFunction.html" title="type parameter in HashTable.HashEqualFunction">StructType</a>&gt;, <a href="HashTable.HashFunction.html" title="interface in com.ibm.j9ddr.vm29.j9">HashTable.HashFunction</a>&lt;<a href="HashTable.HashFunction.html" title="type parameter in HashTable.HashFunction">StructType</a>&gt;</code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields.inherited.from.class.com.ibm.j9ddr.vm29.j9.HashTable">Fields declared in class&nbsp;com.ibm.j9ddr.vm29.j9.<a href="HashTable.html" title="class in com.ibm.j9ddr.vm29.j9">HashTable</a></h3>
<code><a href="HashTable.html#_comparatorFn">_comparatorFn</a>, <a href="HashTable.html#_equalFn">_equalFn</a>, <a href="HashTable.html#_hashFn">_hashFn</a>, <a href="HashTable.html#_structType">_structType</a>, <a href="HashTable.html#_table">_table</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 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(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer,boolean,java.lang.Class,com.ibm.j9ddr.vm29.j9.HashTable.HashEqualFunction,com.ibm.j9ddr.vm29.j9.HashTable.HashFunction)">ModuleHashTable</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer&nbsp;hashTablePointer,
boolean&nbsp;isInline,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;&nbsp;structType,
<a href="HashTable.HashEqualFunction.html" title="interface in com.ibm.j9ddr.vm29.j9">HashTable.HashEqualFunction</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;&nbsp;equalFn,
<a href="HashTable.HashFunction.html" title="interface in com.ibm.j9ddr.vm29.j9">HashTable.HashFunction</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;&nbsp;hashFn)</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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="HashTable.html" title="class in com.ibm.j9ddr.vm29.j9">HashTable</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;</code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#fromJ9HashTable(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer)">fromJ9HashTable</a></span>&#8203;(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer&nbsp;structure)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Opens J9HashTable from J9HashTablePointer</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.j9ddr.vm29.j9.HashTable_V1">Methods declared in class&nbsp;com.ibm.j9ddr.vm29.j9.<a href="HashTable_V1.html" title="class in com.ibm.j9ddr.vm29.j9">HashTable_V1</a></h3>
<code><a href="HashTable_V1.html#find(StructType)">find</a>, <a href="HashTable_V1.html#getCount()">getCount</a>, <a href="HashTable_V1.html#getTableName()">getTableName</a>, <a href="HashTable_V1.html#isSpaceOpt()">isSpaceOpt</a>, <a href="HashTable_V1.html#iterator()">iterator</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.j9ddr.vm29.j9.HashTable">Methods declared in class&nbsp;com.ibm.j9ddr.vm29.j9.<a href="HashTable.html" title="class in com.ibm.j9ddr.vm29.j9">HashTable</a></h3>
<code><a href="HashTable.html#fromJ9HashTable(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer,boolean,java.lang.Class,com.ibm.j9ddr.vm29.j9.HashTable.HashEqualFunction,com.ibm.j9ddr.vm29.j9.HashTable.HashFunction)">fromJ9HashTable</a>, <a href="HashTable.html#fromJ9HashTable(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer,boolean,java.lang.Class,com.ibm.j9ddr.vm29.j9.HashTable.HashFunction,com.ibm.j9ddr.vm29.j9.HashTable.HashComparatorFunction)">fromJ9HashTable</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">
<!-- ========= 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;(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer,boolean,java.lang.Class,com.ibm.j9ddr.vm29.j9.HashTable.HashEqualFunction,com.ibm.j9ddr.vm29.j9.HashTable.HashFunction)">
<h3>ModuleHashTable</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">ModuleHashTable</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer&nbsp;hashTablePointer,
boolean&nbsp;isInline,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;&nbsp;structType,
<a href="HashTable.HashEqualFunction.html" title="interface in com.ibm.j9ddr.vm29.j9">HashTable.HashEqualFunction</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;&nbsp;equalFn,
<a href="HashTable.HashFunction.html" title="interface in com.ibm.j9ddr.vm29.j9">HashTable.HashFunction</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;&nbsp;hashFn)</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="fromJ9HashTable(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer)">
<h3>fromJ9HashTable</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="HashTable.html" title="class in com.ibm.j9ddr.vm29.j9">HashTable</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9ModulePointer&gt;</span>&nbsp;<span class="element-name">fromJ9HashTable</span>&#8203;<span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9HashTablePointer&nbsp;structure)</span>
throws <span class="exceptions"><a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div>
<div class="block">Opens J9HashTable from J9HashTablePointer</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>structure</code> - the J9HashTablePointer</dd>
<dt>Throws:</dt>
<dd><code><a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code> - when fails to read from structure</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>