| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>PHDJavaObject.Builder (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.dtfj.phd, class: PHDJavaObject, class: Builder"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.dtfj.phd.PHDJavaObject.Builder class"> |
| <meta name="keywords" content="refs()"> |
| <meta name="keywords" content="refsAsArray()"> |
| <meta name="keywords" content="length()"> |
| <meta name="keywords" content="instanceSize()"> |
| <meta name="keywords" content="build()"> |
| <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/PHDJavaObject.Builder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.dtfj.phd</a></div> |
| <h1 title="Class PHDJavaObject.Builder" class="title">Class PHDJavaObject.Builder</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a> |
| <div class="inheritance">com.ibm.dtfj.phd.PHDJavaObject.Builder</div> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="PHDJavaObject.html" title="class in com.ibm.dtfj.phd">PHDJavaObject</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">PHDJavaObject.Builder</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span></div> |
| <div class="block">The constructors for PHDJavaObject used to take up to 11 arguments, many of which were ints. This made it hard to tie up which |
| argument corresponded to which parameter and invited errors since there can be no type checking. |
| <p> |
| This is now fixed by the use of the Builder pattern as described in |
| Effective Java Second Edition by Joshua Bloch (http://cyclo.ps/books/Prentice.Hall.Effective.Java.2nd.Edition.May.2008.pdf), |
| item 2 "Consider a builder when faced with many constructor parameters". |
| <p> |
| The only way to construct a PHDJavaObject is now using this Builder. Required arguments are set with |
| a call to the Builder constructor, then optional arguments are set, then build() is called, usually all |
| in one line using a fluent interface.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor.summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.dtfj.phd.PHDJavaHeap,long,com.ibm.dtfj.java.JavaClass,int,int)">Builder</a></span>​(com.ibm.dtfj.phd.PHDJavaHeap heap, |
| long address, |
| <a href="../java/JavaClass.html" title="interface in com.ibm.dtfj.java">JavaClass</a> cls, |
| int flags, |
| int hashCode)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Initialize a Builder for a PHDJavaClass with the five required parameters.</div> |
| </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><a href="PHDJavaObject.html" title="class in com.ibm.dtfj.phd">PHDJavaObject</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="#build()">build</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">Build the PHDJavaObject using all the required and optional values given so far.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="PHDJavaObject.Builder.html" title="class in com.ibm.dtfj.phd">PHDJavaObject.Builder</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="#instanceSize(long)">instanceSize</a></span>​(long instanceSize)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Add the instance size attribute to a PHDJavaObject before building it.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="PHDJavaObject.Builder.html" title="class in com.ibm.dtfj.phd">PHDJavaObject.Builder</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="#length(int)">length</a></span>​(int length)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Add the length attribute to a PHDJavaObject before building it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="PHDJavaObject.Builder.html" title="class in com.ibm.dtfj.phd">PHDJavaObject.Builder</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="#refs(com.ibm.dtfj.phd.util.LongEnumeration,int)">refs</a></span>​(<a href="util/LongEnumeration.html" title="interface in com.ibm.dtfj.phd.util">LongEnumeration</a> refs, |
| int skipped)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Add the refs attribute to a PHDJavaObject before building it.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="PHDJavaObject.Builder.html" title="class in com.ibm.dtfj.phd">PHDJavaObject.Builder</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="#refsAsArray(long%5B%5D,int)">refsAsArray</a></span>​(long[] refs, |
| int skipped)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Add the refs attribute to a PHDJavaObject before building it.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor.detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(com.ibm.dtfj.phd.PHDJavaHeap,long,com.ibm.dtfj.java.JavaClass,int,int)"> |
| <h3>Builder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Builder</span>​<span class="parameters">(com.ibm.dtfj.phd.PHDJavaHeap heap, |
| long address, |
| <a href="../java/JavaClass.html" title="interface in com.ibm.dtfj.java">JavaClass</a> cls, |
| int flags, |
| int hashCode)</span></div> |
| <div class="block">Initialize a Builder for a PHDJavaClass with the five required parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>heap</code> - </dd> |
| <dd><code>address</code> - </dd> |
| <dd><code>cls</code> - </dd> |
| <dd><code>flags</code> - </dd> |
| <dd><code>hashCode</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="refs(com.ibm.dtfj.phd.util.LongEnumeration,int)"> |
| <h3>refs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PHDJavaObject.Builder.html" title="class in com.ibm.dtfj.phd">PHDJavaObject.Builder</a></span> <span class="element-name">refs</span>​<span class="parameters">(<a href="util/LongEnumeration.html" title="interface in com.ibm.dtfj.phd.util">LongEnumeration</a> refs, |
| int skipped)</span></div> |
| <div class="block">Add the refs attribute to a PHDJavaObject before building it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>refs</code> - </dd> |
| <dd><code>skipped</code> - </dd> |
| <dt>Returns:</dt> |
| <dd>the builder for further attributes or a call to build()</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="refsAsArray(long[],int)"> |
| <h3>refsAsArray</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PHDJavaObject.Builder.html" title="class in com.ibm.dtfj.phd">PHDJavaObject.Builder</a></span> <span class="element-name">refsAsArray</span>​<span class="parameters">(long[] refs, |
| int skipped)</span></div> |
| <div class="block">Add the refs attribute to a PHDJavaObject before building it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>refs</code> - </dd> |
| <dd><code>skipped</code> - </dd> |
| <dt>Returns:</dt> |
| <dd>the builder for further attributes or a call to build()</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="length(int)"> |
| <h3>length</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PHDJavaObject.Builder.html" title="class in com.ibm.dtfj.phd">PHDJavaObject.Builder</a></span> <span class="element-name">length</span>​<span class="parameters">(int length)</span></div> |
| <div class="block">Add the length attribute to a PHDJavaObject before building it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>length</code> - </dd> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="instanceSize(long)"> |
| <h3>instanceSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PHDJavaObject.Builder.html" title="class in com.ibm.dtfj.phd">PHDJavaObject.Builder</a></span> <span class="element-name">instanceSize</span>​<span class="parameters">(long instanceSize)</span></div> |
| <div class="block">Add the instance size attribute to a PHDJavaObject before building it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>instance</code> - size</dd> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="build()"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PHDJavaObject.html" title="class in com.ibm.dtfj.phd">PHDJavaObject</a></span> <span class="element-name">build</span>()</div> |
| <div class="block">Build the PHDJavaObject using all the required and optional values given so far.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the PHDJavaObject</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
