| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>SectionParser (OpenJ9 JDK 18)</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.javacore.parser.j9, class: SectionParser"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.dtfj.javacore.parser.j9.SectionParser class"> |
| <meta name="keywords" content="fImageBuilder"> |
| <meta name="keywords" content="LOOKAHEAD_DEPTH"> |
| <meta name="keywords" content="readIntoDTFJ()"> |
| <meta name="keywords" content="addAsProperty()"> |
| <meta name="keywords" content="topLevelRule()"> |
| <meta name="keywords" content="sovOnlyRules()"> |
| <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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span></button> |
| <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 18</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/SectionParser.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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <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> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <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> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <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-input">SEARCH:</label> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </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.javacore.parser.j9</a></div> |
| <h1 title="Class SectionParser" class="title">Class SectionParser</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/18/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="SectionParserGrammar.html" title="class in com.ibm.dtfj.javacore.parser.j9">com.ibm.dtfj.javacore.parser.j9.SectionParserGrammar</a> |
| <div class="inheritance">com.ibm.dtfj.javacore.parser.j9.SectionParser</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../framework/parser/ISectionParser.html" title="interface in com.ibm.dtfj.javacore.parser.framework.parser">ISectionParser</a></code>, <code><a href="section/common/ICommonTypes.html" title="interface in com.ibm.dtfj.javacore.parser.j9.section.common">ICommonTypes</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="section/classloader/ClassLoaderSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.classloader">ClassLoaderSectionParser</a></code>, <code><a href="section/environment/EnvironmentSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.environment">EnvironmentSectionParser</a></code>, <code><a href="section/memory/MemorySectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.memory">MemorySectionParser</a></code>, <code><a href="section/monitor/MonitorSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.monitor">MonitorSectionParser</a></code>, <code><a href="section/nativememory/NativeMemorySectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.nativememory">NativeMemorySectionParser</a></code>, <code><a href="section/platform/PlatformSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.platform">PlatformSectionParser</a></code>, <code><a href="section/stack/StackSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.stack">StackSectionParser</a></code>, <code><a href="section/thread/ThreadSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.thread">ThreadSectionParser</a></code>, <code><a href="section/title/TitleSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.title">TitleSectionParser</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">SectionParser</span> |
| <span class="extends-implements">extends <a href="SectionParserGrammar.html" title="class in com.ibm.dtfj.javacore.parser.j9">SectionParserGrammar</a> |
| implements <a href="section/common/ICommonTypes.html" title="interface in com.ibm.dtfj.javacore.parser.j9.section.common">ICommonTypes</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="../../builder/IImageBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageBuilder</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#fImageBuilder" class="member-name-link">fImageBuilder</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOOKAHEAD_DEPTH" class="member-name-link">LOOKAHEAD_DEPTH</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Depth of at least 3 is needed for J9 javacores, |
| as parsing a section from the start will |
| yield three tokens: |
| SECTION, header information token, first TAG of section |
| (note that NULL lines are ignored by the scanner).</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-com.ibm.dtfj.javacore.parser.j9.SectionParserGrammar">Fields declared in class com.ibm.dtfj.javacore.parser.j9.<a href="SectionParserGrammar.html" title="class in com.ibm.dtfj.javacore.parser.j9">SectionParserGrammar</a></h3> |
| <code><a href="SectionParserGrammar.html#anyMatched">anyMatched</a>, <a href="SectionParserGrammar.html#DEFAULT_DEPTH">DEFAULT_DEPTH</a>, <a href="SectionParserGrammar.html#fLookAheadBuffer">fLookAheadBuffer</a>, <a href="SectionParserGrammar.html#FORCE_THROW">FORCE_THROW</a>, <a href="SectionParserGrammar.html#fSectionName">fSectionName</a>, <a href="SectionParserGrammar.html#fTagManager">fTagManager</a>, <a href="SectionParserGrammar.html#fTagParser">fTagParser</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-com.ibm.dtfj.javacore.parser.j9.section.common.ICommonTypes">Fields declared in interface com.ibm.dtfj.javacore.parser.j9.section.common.<a href="section/common/ICommonTypes.html" title="interface in com.ibm.dtfj.javacore.parser.j9.section.common">ICommonTypes</a></h3> |
| <code><a href="section/common/ICommonTypes.html#BUILD_INFO">BUILD_INFO</a>, <a href="section/common/ICommonTypes.html#COMMON">COMMON</a>, <a href="section/common/ICommonTypes.html#JIT_BUILD_VERSION">JIT_BUILD_VERSION</a>, <a href="section/common/ICommonTypes.html#JIT_PRESENT">JIT_PRESENT</a>, <a href="section/common/ICommonTypes.html#JRE_NAME">JRE_NAME</a>, <a href="section/common/ICommonTypes.html#JRE_VERSION">JRE_VERSION</a>, <a href="section/common/ICommonTypes.html#NULL">NULL</a>, <a href="section/common/ICommonTypes.html#POINTER_SIZE">POINTER_SIZE</a>, <a href="section/common/ICommonTypes.html#SECTION">SECTION</a>, <a href="section/common/ICommonTypes.html#UNAVAILABLE_DATA">UNAVAILABLE_DATA</a>, <a href="section/common/ICommonTypes.html#VM_VERSION">VM_VERSION</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><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">SectionParser</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> sectionName)</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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAsProperty(java.util.Properties,java.lang.String,java.lang.String)" class="member-name-link">addAsProperty</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a> properties, |
| <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readIntoDTFJ(com.ibm.dtfj.javacore.parser.framework.parser.ILookAheadBuffer,com.ibm.dtfj.javacore.builder.IImageBuilder)" class="member-name-link">readIntoDTFJ</a><wbr>(<a href="../framework/parser/ILookAheadBuffer.html" title="interface in com.ibm.dtfj.javacore.parser.framework.parser">ILookAheadBuffer</a> lookAheadBuffer, |
| <a href="../../builder/IImageBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageBuilder</a> imageBuilder)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Pass in a lookahead buffer that is shared amongst all section parsers, pass in the DTFJ factory |
| to construct the DTFJ objects as tags are being parsed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#sovOnlyRules(java.lang.String)" class="member-name-link">sovOnlyRules</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> startingTag)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#topLevelRule()" class="member-name-link">topLevelRule</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Must be implemented by subclass.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-com.ibm.dtfj.javacore.parser.j9.SectionParserGrammar">Methods declared in class com.ibm.dtfj.javacore.parser.j9.<a href="SectionParserGrammar.html" title="class in com.ibm.dtfj.javacore.parser.j9">SectionParserGrammar</a></h3> |
| <code><a href="SectionParserGrammar.html#anyMatched()">anyMatched</a>, <a href="SectionParserGrammar.html#consume()">consume</a>, <a href="SectionParserGrammar.html#getCurrentFileLineNumber()">getCurrentFileLineNumber</a>, <a href="SectionParserGrammar.html#getErrors()">getErrors</a>, <a href="SectionParserGrammar.html#getLineRuleResults(com.ibm.dtfj.javacore.parser.framework.scanner.IParserToken)">getLineRuleResults</a>, <a href="SectionParserGrammar.html#getLookAheadBuffer()">getLookAheadBuffer</a>, <a href="SectionParserGrammar.html#getSectionName()">getSectionName</a>, <a href="SectionParserGrammar.html#handleError(java.lang.Exception)">handleError</a>, <a href="SectionParserGrammar.html#handleError(java.lang.Exception,int)">handleError</a>, <a href="SectionParserGrammar.html#handleError(java.lang.String)">handleError</a>, <a href="SectionParserGrammar.html#handleError(java.lang.String,int,int)">handleError</a>, <a href="SectionParserGrammar.html#handleError(java.lang.String,java.lang.Exception)">handleError</a>, <a href="SectionParserGrammar.html#handleErrorAtLineNumber(int,java.lang.String,java.lang.Exception)">handleErrorAtLineNumber</a>, <a href="SectionParserGrammar.html#handleRequiredMismatch(java.lang.String,java.lang.String,java.lang.String)">handleRequiredMismatch</a>, <a href="SectionParserGrammar.html#handleUnknownMismatch(java.lang.String,java.lang.String)">handleUnknownMismatch</a>, <a href="SectionParserGrammar.html#isValidJavaCoreTag(com.ibm.dtfj.javacore.parser.framework.scanner.IParserToken)">isValidJavaCoreTag</a>, <a href="SectionParserGrammar.html#isValidSectionTag(java.lang.String)">isValidSectionTag</a>, <a href="SectionParserGrammar.html#lookAhead(int)">lookAhead</a>, <a href="SectionParserGrammar.html#match(java.lang.String,boolean)">match</a>, <a href="SectionParserGrammar.html#matchOptional(java.lang.String)">matchOptional</a>, <a href="SectionParserGrammar.html#matchRequired(java.lang.String)">matchRequired</a>, <a href="SectionParserGrammar.html#processTagLineOptional(java.lang.String)">processTagLineOptional</a>, <a href="SectionParserGrammar.html#processTagLineRequired(java.lang.String)">processTagLineRequired</a>, <a href="SectionParserGrammar.html#setLookAheadBuffer(com.ibm.dtfj.javacore.parser.framework.parser.ILookAheadBuffer)">setLookAheadBuffer</a>, <a href="SectionParserGrammar.html#setLookAheadBuffer(com.ibm.dtfj.javacore.parser.framework.parser.ILookAheadBuffer,int)">setLookAheadBuffer</a>, <a href="SectionParserGrammar.html#setTagManager(com.ibm.dtfj.javacore.parser.j9.J9TagManager)">setTagManager</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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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/18/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="fImageBuilder"> |
| <h3>fImageBuilder</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../builder/IImageBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageBuilder</a></span> <span class="element-name">fImageBuilder</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOOKAHEAD_DEPTH"> |
| <h3>LOOKAHEAD_DEPTH</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">LOOKAHEAD_DEPTH</span></div> |
| <div class="block">Depth of at least 3 is needed for J9 javacores, |
| as parsing a section from the start will |
| yield three tokens: |
| SECTION, header information token, first TAG of section |
| (note that NULL lines are ignored by the scanner). |
| Adjust as necessary for deeper analysis.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../../constant-values.html#com.ibm.dtfj.javacore.parser.j9.SectionParser.LOOKAHEAD_DEPTH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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>(java.lang.String)"> |
| <h3>SectionParser</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SectionParser</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> sectionName)</span></div> |
| </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="readIntoDTFJ(com.ibm.dtfj.javacore.parser.framework.parser.ILookAheadBuffer,com.ibm.dtfj.javacore.builder.IImageBuilder)"> |
| <h3>readIntoDTFJ</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">readIntoDTFJ</span><wbr><span class="parameters">(<a href="../framework/parser/ILookAheadBuffer.html" title="interface in com.ibm.dtfj.javacore.parser.framework.parser">ILookAheadBuffer</a> lookAheadBuffer, |
| <a href="../../builder/IImageBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageBuilder</a> imageBuilder)</span> |
| throws <span class="exceptions"><a href="../framework/parser/ParserException.html" title="class in com.ibm.dtfj.javacore.parser.framework.parser">ParserException</a></span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="../framework/parser/ISectionParser.html#readIntoDTFJ(com.ibm.dtfj.javacore.parser.framework.parser.ILookAheadBuffer,com.ibm.dtfj.javacore.builder.IImageBuilder)">ISectionParser</a></code></span></div> |
| <div class="block">Pass in a lookahead buffer that is shared amongst all section parsers, pass in the DTFJ factory |
| to construct the DTFJ objects as tags are being parsed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../framework/parser/ISectionParser.html#readIntoDTFJ(com.ibm.dtfj.javacore.parser.framework.parser.ILookAheadBuffer,com.ibm.dtfj.javacore.builder.IImageBuilder)">readIntoDTFJ</a></code> in interface <code><a href="../framework/parser/ISectionParser.html" title="interface in com.ibm.dtfj.javacore.parser.framework.parser">ISectionParser</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>lookahead</code> - from where to read tokens</dd> |
| <dd><code>tag</code> - information containing current tag information at the time of the parse</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if a null lookaheadbuffer is passed.</dd> |
| <dd><code><a href="../framework/parser/ParserException.html" title="class in com.ibm.dtfj.javacore.parser.framework.parser">ParserException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAsProperty(java.util.Properties,java.lang.String,java.lang.String)"> |
| <h3>addAsProperty</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">addAsProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link" target="_blank">Properties</a> properties, |
| <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> value)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>properties</code> - </dd> |
| <dd><code>key</code> - </dd> |
| <dd><code>value</code> - </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="topLevelRule()"> |
| <h3>topLevelRule</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">void</span> <span class="element-name">topLevelRule</span>() |
| throws <span class="exceptions"><a href="../framework/parser/ParserException.html" title="class in com.ibm.dtfj.javacore.parser.framework.parser">ParserException</a></span></div> |
| <div class="block">Must be implemented by subclass.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>lookAheadBuffer</code> - </dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../framework/parser/ParserException.html" title="class in com.ibm.dtfj.javacore.parser.framework.parser">ParserException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sovOnlyRules(java.lang.String)"> |
| <h3>sovOnlyRules</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">void</span> <span class="element-name">sovOnlyRules</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> startingTag)</span> |
| throws <span class="exceptions"><a href="../framework/parser/ParserException.html" title="class in com.ibm.dtfj.javacore.parser.framework.parser">ParserException</a></span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startingTag</code> - </dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../framework/parser/ParserException.html" title="class in com.ibm.dtfj.javacore.parser.framework.parser">ParserException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2022 IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |