blob: e1ac5153073f2ee6c6e38f838954dd44dd955246 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>ISectionParser (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.javacore.parser.framework.parser, interface: ISectionParser">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.dtfj.javacore.parser.framework.parser.ISectionParser interface">
<meta name="keywords" content="readIntoDTFJ()">
<meta name="keywords" content="getErrors()">
<meta name="keywords" content="getSectionName()">
<meta name="keywords" content="anyMatched()">
<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/ISectionParser.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.dtfj.javacore.parser.framework.parser</a></div>
<h1 title="Interface ISectionParser" class="title">Interface ISectionParser</h1>
</div>
<section class="description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../j9/section/classloader/ClassLoaderSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.classloader">ClassLoaderSectionParser</a></code>, <code><a href="../../j9/section/environment/EnvironmentSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.environment">EnvironmentSectionParser</a></code>, <code><a href="../../j9/section/memory/MemorySectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.memory">MemorySectionParser</a></code>, <code><a href="../../j9/section/monitor/MonitorSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.monitor">MonitorSectionParser</a></code>, <code><a href="../../j9/section/monitor/MonitorSovSectionParserPart.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.monitor">MonitorSovSectionParserPart</a></code>, <code><a href="../../j9/section/nativememory/NativeMemorySectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.nativememory">NativeMemorySectionParser</a></code>, <code><a href="../../j9/section/platform/PlatformSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.platform">PlatformSectionParser</a></code>, <code><a href="../../j9/SectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9">SectionParser</a></code>, <code><a href="../../j9/SectionParserGrammar.html" title="class in com.ibm.dtfj.javacore.parser.j9">SectionParserGrammar</a></code>, <code><a href="../../j9/SovereignSectionParserPart.html" title="class in com.ibm.dtfj.javacore.parser.j9">SovereignSectionParserPart</a></code>, <code><a href="../../j9/section/stack/StackSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.stack">StackSectionParser</a></code>, <code><a href="../../j9/section/thread/ThreadSectionParser.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.thread">ThreadSectionParser</a></code>, <code><a href="../../j9/section/thread/ThreadSovSectionParserPart.html" title="class in com.ibm.dtfj.javacore.parser.j9.section.thread">ThreadSovSectionParserPart</a></code>, <code><a href="../../j9/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 interface </span><span class="element-name type-name-label">ISectionParser</span></div>
<div class="block">Parses a section of a javacore. Each javacore section has its own section parser.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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></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 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#anyMatched()">anyMatched</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getErrors()">getErrors</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getSectionName()">getSectionName</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#readIntoDTFJ(com.ibm.dtfj.javacore.parser.framework.parser.ILookAheadBuffer,com.ibm.dtfj.javacore.builder.IImageBuilder)">readIntoDTFJ</a></span>&#8203;(<a href="ILookAheadBuffer.html" title="interface in com.ibm.dtfj.javacore.parser.framework.parser">ILookAheadBuffer</a>&nbsp;lookAhead,
<a href="../../../builder/IImageBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageBuilder</a>&nbsp;imageBuilder)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<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>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ 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="return-type">void</span>&nbsp;<span class="element-name">readIntoDTFJ</span>&#8203;<span class="parameters">(<a href="ILookAheadBuffer.html" title="interface in com.ibm.dtfj.javacore.parser.framework.parser">ILookAheadBuffer</a>&nbsp;lookAhead,
<a href="../../../builder/IImageBuilder.html" title="interface in com.ibm.dtfj.javacore.builder">IImageBuilder</a>&nbsp;imageBuilder)</span>
throws <span class="exceptions"><a href="ParserException.html" title="class in com.ibm.dtfj.javacore.parser.framework.parser">ParserException</a></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>Parameters:</dt>
<dd><code>lookAhead</code> - </dd>
<dd><code>imageBuilder</code> - </dd>
<dt>Throws:</dt>
<dd><code><a href="ParserException.html" title="class in com.ibm.dtfj.javacore.parser.framework.parser">ParserException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getErrors()">
<h3>getErrors</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</a></span>&nbsp;<span class="element-name">getErrors</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getSectionName()">
<h3>getSectionName</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">getSectionName</span>()</div>
</section>
</li>
<li>
<section class="detail" id="anyMatched()">
<h3>anyMatched</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">anyMatched</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>