| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>IFieldFormatter (OpenJ9 JDK 11)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="keywords" content="com.ibm.j9ddr.tools.ddrinteractive.IFieldFormatter interface"> |
| <meta name="keywords" content="preFormat()"> |
| <meta name="keywords" content="format()"> |
| <meta name="keywords" content="postFormat()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IFieldFormatter (OpenJ9 JDK 11)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" 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="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IFieldFormatter.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 class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.ibm.j9ddr.tools.ddrinteractive</a></div> |
| <h2 title="Interface IFieldFormatter" class="title">Interface IFieldFormatter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../vm29/tools/ddrinteractive/structureformat/base/ArrayFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">ArrayFormatter</a></code>, <code><a href="BaseFieldFormatter.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">BaseFieldFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/BoolFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">BoolFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/extensions/CStringFieldFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.extensions">CStringFieldFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/DoubleFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">DoubleFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/EnumFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">EnumFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/FloatFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">FloatFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/extensions/J9ClassFieldFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.extensions">J9ClassFieldFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/extensions/J9ConstantPoolFieldFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.extensions">J9ConstantPoolFieldFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/extensions/J9MethodFieldFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.extensions">J9MethodFieldFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/extensions/J9ObjectFieldFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.extensions">J9ObjectFieldFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/J9SRPFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">J9SRPFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/PointerFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">PointerFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/ScalarFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">ScalarFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/StructureFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">StructureFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/StructurePointerFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">StructurePointerFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/U64ScalarFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">U64ScalarFormatter</a></code>, <code><a href="../../vm29/tools/ddrinteractive/structureformat/base/VoidFormatter.html" title="class in com.ibm.j9ddr.vm29.tools.ddrinteractive.structureformat.base">VoidFormatter</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IFieldFormatter</span></pre> |
| <div class="block">Interface for objects that format fields in structures. |
| |
| e.g. turning |
| |
| struct J9NativeLibrary * librariesTail |
| |
| into |
| |
| !j9nativelibrary 0x0019CDA8 |
| |
| |
| The IFieldFormatters form a chain of responsibility. The structure ICommand |
| calls each IFieldFormatter in turn three times. |
| |
| The first pass calls preFormat() (stopping either when a IFieldFormatter |
| returns STOP_WALKING, or the end of the chain is reached.) |
| The second pass calls format() - where the default formatting behaviour |
| is run. |
| The third pass calls postFormat()</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="FormatWalkResult.html" title="enum in com.ibm.j9ddr.tools.ddrinteractive">FormatWalkResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format(java.lang.String,java.lang.String,java.lang.String,int,long,java.io.PrintStream,com.ibm.j9ddr.tools.ddrinteractive.Context,com.ibm.j9ddr.tools.ddrinteractive.IStructureFormatter)">format</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> declaredType, |
| int typeCode, |
| long address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/PrintStream.html?is-external=true" title="class or interface in java.io" class="externalLink" target="_blank">PrintStream</a> out, |
| <a href="Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a> context, |
| <a href="IStructureFormatter.html" title="interface in com.ibm.j9ddr.tools.ddrinteractive">IStructureFormatter</a> structureFormatter)</code></th> |
| <td class="colLast"> |
| <div class="block">Method called by the Structure command to format a field, after preFormat() and before postFormat()</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="FormatWalkResult.html" title="enum in com.ibm.j9ddr.tools.ddrinteractive">FormatWalkResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#postFormat(java.lang.String,java.lang.String,java.lang.String,int,long,java.io.PrintStream,com.ibm.j9ddr.tools.ddrinteractive.Context,com.ibm.j9ddr.tools.ddrinteractive.IStructureFormatter)">postFormat</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> declaredType, |
| int typeCode, |
| long address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/PrintStream.html?is-external=true" title="class or interface in java.io" class="externalLink" target="_blank">PrintStream</a> out, |
| <a href="Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a> context, |
| <a href="IStructureFormatter.html" title="interface in com.ibm.j9ddr.tools.ddrinteractive">IStructureFormatter</a> structureFormatter)</code></th> |
| <td class="colLast"> |
| <div class="block">Method called by the Structure command after preFormat() and format().</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="FormatWalkResult.html" title="enum in com.ibm.j9ddr.tools.ddrinteractive">FormatWalkResult</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#preFormat(java.lang.String,java.lang.String,java.lang.String,int,long,java.io.PrintStream,com.ibm.j9ddr.tools.ddrinteractive.Context,com.ibm.j9ddr.tools.ddrinteractive.IStructureFormatter)">preFormat</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> declaredType, |
| int typeCode, |
| long address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/PrintStream.html?is-external=true" title="class or interface in java.io" class="externalLink" target="_blank">PrintStream</a> out, |
| <a href="Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a> context, |
| <a href="IStructureFormatter.html" title="interface in com.ibm.j9ddr.tools.ddrinteractive">IStructureFormatter</a> structureFormatter)</code></th> |
| <td class="colLast"> |
| <div class="block">Method called by the Structure command before the format() method walk.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="preFormat(java.lang.String,java.lang.String,java.lang.String,int,long,java.io.PrintStream,com.ibm.j9ddr.tools.ddrinteractive.Context,com.ibm.j9ddr.tools.ddrinteractive.IStructureFormatter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preFormat</h4> |
| <pre class="methodSignature"><a href="FormatWalkResult.html" title="enum in com.ibm.j9ddr.tools.ddrinteractive">FormatWalkResult</a> preFormat​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> declaredType, |
| int typeCode, |
| long address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/PrintStream.html?is-external=true" title="class or interface in java.io" class="externalLink" target="_blank">PrintStream</a> out, |
| <a href="Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a> context, |
| <a href="IStructureFormatter.html" title="interface in com.ibm.j9ddr.tools.ddrinteractive">IStructureFormatter</a> structureFormatter) |
| throws <a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></pre> |
| <div class="block">Method called by the Structure command before the format() method walk.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of field being formatted.</dd> |
| <dd><code>type</code> - Type of field to be formatted. E.g. struct J9JavaVM</dd> |
| <dd><code>declaredType</code> - Type as declared in C. E.g. This may be char* where type is U8*</dd> |
| <dd><code>typeCode</code> - StructureHelper type code. E.g. TYPE_STRUCTURE</dd> |
| <dd><code>address</code> - Address of field to be formatted</dd> |
| <dd><code>out</code> - PrintStream to write result to. Do not write a new line at the end of your output.</dd> |
| <dd><code>context</code> - Current DDRInteractive context</dd> |
| <dd><code>formattingDirector</code> - FormattingDirector; useful if you need to rerun a different field format (e.g. when working with J9SRPs)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>KEEP_WALKING if the format walk should keep going (delegating to other formatters), STOP_WALKING if the format walk should stop</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="format(java.lang.String,java.lang.String,java.lang.String,int,long,java.io.PrintStream,com.ibm.j9ddr.tools.ddrinteractive.Context,com.ibm.j9ddr.tools.ddrinteractive.IStructureFormatter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>format</h4> |
| <pre class="methodSignature"><a href="FormatWalkResult.html" title="enum in com.ibm.j9ddr.tools.ddrinteractive">FormatWalkResult</a> format​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> declaredType, |
| int typeCode, |
| long address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/PrintStream.html?is-external=true" title="class or interface in java.io" class="externalLink" target="_blank">PrintStream</a> out, |
| <a href="Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a> context, |
| <a href="IStructureFormatter.html" title="interface in com.ibm.j9ddr.tools.ddrinteractive">IStructureFormatter</a> structureFormatter) |
| throws <a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></pre> |
| <div class="block">Method called by the Structure command to format a field, after preFormat() and before postFormat()</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of field being formatted.</dd> |
| <dd><code>type</code> - Type of field to be formatted. E.g. struct J9JavaVM</dd> |
| <dd><code>declaredType</code> - Type as declared in C. E.g. This may be char* where type is U8*</dd> |
| <dd><code>typeCode</code> - StructureHelper type code. E.g. TYPE_STRUCTURE</dd> |
| <dd><code>address</code> - Address of field to be formatted</dd> |
| <dd><code>out</code> - PrintStream to write result to. Do not write a new line at the end of your output.</dd> |
| <dd><code>context</code> - Current DDRInteractive context</dd> |
| <dd><code>formattingDirector</code> - FormattingDirector; useful if you need to rerun a different field format (e.g. when working with J9SRPs)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>KEEP_WALKING if the format walk should keep going (delegating to other formatters), STOP_WALKING if the format walk should stop</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="postFormat(java.lang.String,java.lang.String,java.lang.String,int,long,java.io.PrintStream,com.ibm.j9ddr.tools.ddrinteractive.Context,com.ibm.j9ddr.tools.ddrinteractive.IStructureFormatter)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>postFormat</h4> |
| <pre class="methodSignature"><a href="FormatWalkResult.html" title="enum in com.ibm.j9ddr.tools.ddrinteractive">FormatWalkResult</a> postFormat​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> declaredType, |
| int typeCode, |
| long address, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/PrintStream.html?is-external=true" title="class or interface in java.io" class="externalLink" target="_blank">PrintStream</a> out, |
| <a href="Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a> context, |
| <a href="IStructureFormatter.html" title="interface in com.ibm.j9ddr.tools.ddrinteractive">IStructureFormatter</a> structureFormatter) |
| throws <a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></pre> |
| <div class="block">Method called by the Structure command after preFormat() and format().</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of field being formatted.</dd> |
| <dd><code>type</code> - Type of field to be formatted. E.g. struct J9JavaVM</dd> |
| <dd><code>declaredType</code> - Type as declared in C. E.g. This may be char* where type is U8*</dd> |
| <dd><code>typeCode</code> - StructureHelper type code. E.g. TYPE_STRUCTURE</dd> |
| <dd><code>address</code> - Address of field to be formatted</dd> |
| <dd><code>out</code> - PrintStream to write result to. Do not write a new line at the end of your output.</dd> |
| <dd><code>context</code> - Current DDRInteractive context</dd> |
| <dd><code>structureFormatter</code> - StructureFormatter; useful if you need to rerun a different field format (e.g. when working with J9SRPs)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>KEEP_WALKING if the format walk should keep going (delegating to other formatters), STOP_WALKING if the format walk should stop</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" 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="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IFieldFormatter.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 class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><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> |
| </body> |
| </html> |
