Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk16 / openj9.traceformat / com / ibm / jvm / format / TraceRecordInternal.html
blob: df8f0ff7b80ac56204d827dc202f5b4afe57f127 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>TraceRecordInternal (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.traceformat, package: com.ibm.jvm.format, class: TraceRecordInternal">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.jvm.format.TraceRecordInternal class">
<meta name="keywords" content="prime()">
<meta name="keywords" content="getNextEntry()">
<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/TraceRecordInternal.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../module-summary.html">openj9.traceformat</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.jvm.format</a></div>
<h1 title="Class TraceRecordInternal" class="title">Class TraceRecordInternal</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a>
<div class="inheritance"><a href="TraceRecord.html" title="class in com.ibm.jvm.format">com.ibm.jvm.format.TraceRecord</a>
<div class="inheritance">com.ibm.jvm.format.TraceRecordInternal</div>
</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link" target="_blank">Comparable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">TraceRecordInternal</span>
<span class="extends-implements">extends <a href="TraceRecord.html" title="class in com.ibm.jvm.format">TraceRecord</a></span></div>
<div class="block">Extends Trace Record. Special processing needed for internal trace records.</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="inherited-list">
<h3 id="fields.inherited.from.class.com.ibm.jvm.format.TraceRecord">Fields declared in class&nbsp;com.ibm.jvm.format.<a href="TraceRecord.html" title="class in com.ibm.jvm.format">TraceRecord</a></h3>
<code><a href="TraceRecord.html#APP_TYPE">APP_TYPE</a>, <a href="TraceRecord.html#ASSERT_TYPE">ASSERT_TYPE</a>, <a href="TraceRecord.html#BASE_INDENT">BASE_INDENT</a>, <a href="TraceRecord.html#buffer">buffer</a>, <a href="TraceRecord.html#bufferSize">bufferSize</a>, <a href="TraceRecord.html#Chars">Chars</a>, <a href="TraceRecord.html#currentBuffer">currentBuffer</a>, <a href="TraceRecord.html#currentLength">currentLength</a>, <a href="TraceRecord.html#currentOffset">currentOffset</a>, <a href="TraceRecord.html#currentTimeStamp">currentTimeStamp</a>, <a href="TraceRecord.html#currentTraceID">currentTraceID</a>, <a href="TraceRecord.html#DEBUG_EXCPT_TYPE">DEBUG_EXCPT_TYPE</a>, <a href="TraceRecord.html#DEBUG_TYPE">DEBUG_TYPE</a>, <a href="TraceRecord.html#ENTRY_EXCPT_TYPE">ENTRY_EXCPT_TYPE</a>, <a href="TraceRecord.html#ENTRY_TYPE">ENTRY_TYPE</a>, <a href="TraceRecord.html#ERROR_TYPE">ERROR_TYPE</a>, <a href="TraceRecord.html#EVENT_TYPE">EVENT_TYPE</a>, <a href="TraceRecord.html#EXCEPTION_TYPE">EXCEPTION_TYPE</a>, <a href="TraceRecord.html#EXIT_EXCPT_TYPE">EXIT_EXCPT_TYPE</a>, <a href="TraceRecord.html#EXIT_TYPE">EXIT_TYPE</a>, <a href="TraceRecord.html#headerSize">headerSize</a>, <a href="TraceRecord.html#indentLevels">indentLevels</a>, <a href="TraceRecord.html#lastThread">lastThread</a>, <a href="TraceRecord.html#longEntryTraceIDs">longEntryTraceIDs</a>, <a href="TraceRecord.html#MEM_EXCPT_TYPE">MEM_EXCPT_TYPE</a>, <a href="TraceRecord.html#MEM_TYPE">MEM_TYPE</a>, <a href="TraceRecord.html#nextEight">nextEight</a>, <a href="TraceRecord.html#nextEntry">nextEntry</a>, <a href="TraceRecord.html#notFormatted">notFormatted</a>, <a href="TraceRecord.html#offset">offset</a>, <a href="TraceRecord.html#PERF_EXCPT_TYPE">PERF_EXCPT_TYPE</a>, <a href="TraceRecord.html#PERF_TYPE">PERF_TYPE</a>, <a href="TraceRecord.html#recordFinished">recordFinished</a>, <a href="TraceRecord.html#start">start</a>, <a href="TraceRecord.html#TAB">TAB</a>, <a href="TraceRecord.html#threadID">threadID</a>, <a href="TraceRecord.html#threadName">threadName</a>, <a href="TraceRecord.html#threadSyn1">threadSyn1</a>, <a href="TraceRecord.html#threadSyn2">threadSyn2</a>, <a href="TraceRecord.html#timeStamp">timeStamp</a>, <a href="TraceRecord.html#TIMESTAMP_OFFSET">TIMESTAMP_OFFSET</a>, <a href="TraceRecord.html#traceFile">traceFile</a>, <a href="TraceRecord.html#TRACEID_OFFSET">TRACEID_OFFSET</a>, <a href="TraceRecord.html#traceThread">traceThread</a>, <a href="TraceRecord.html#types">types</a>, <a href="TraceRecord.html#upperWord">upperWord</a>, <a href="TraceRecord.html#wrapTime">wrapTime</a>, <a href="TraceRecord.html#wrapTimes">wrapTimes</a>, <a href="TraceRecord.html#writePlatform">writePlatform</a>, <a href="TraceRecord.html#writeSystem">writeSystem</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor.summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.jvm.format.TraceFile,long)">TraceRecordInternal</a></span>&#8203;(<a href="TraceFile.html" title="class in com.ibm.jvm.format">TraceFile</a>&nbsp;traceFile,
long&nbsp;start)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method.summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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>protected int</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="#getNextEntry()">getNextEntry</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">Gets the next trace entry
returns 0=no more entries in this buffer 1=ok to format</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected void</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="#prime()">prime</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">reads in the record data for this TraceRecord</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.jvm.format.TraceRecord">Methods declared in class&nbsp;com.ibm.jvm.format.<a href="TraceRecord.html" title="class in com.ibm.jvm.format">TraceRecord</a></h3>
<code><a href="TraceRecord.html#compareTo(java.lang.Object)">compareTo</a>, <a href="TraceRecord.html#formatCurrentEntry()">formatCurrentEntry</a>, <a href="TraceRecord.html#getCurrentTimeStamp()">getCurrentTimeStamp</a>, <a href="TraceRecord.html#getIndent(java.lang.String,boolean)">getIndent</a>, <a href="TraceRecord.html#getNextRecord()">getNextRecord</a>, <a href="TraceRecord.html#initStatics()">initStatics</a>, <a href="TraceRecord.html#processNextEntryHeader(byte%5B%5D,int)">processNextEntryHeader</a>, <a href="TraceRecord.html#release()">release</a>, <a href="TraceRecord.html#setIndent(java.lang.String,java.lang.StringBuffer)">setIndent</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(com.ibm.jvm.format.TraceFile,long)">
<h3>TraceRecordInternal</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">TraceRecordInternal</span>&#8203;<span class="parameters">(<a href="TraceFile.html" title="class in com.ibm.jvm.format">TraceFile</a>&nbsp;traceFile,
long&nbsp;start)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="prime()">
<h3>prime</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">prime</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">reads in the record data for this TraceRecord</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNextEntry()">
<h3>getNextEntry</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getNextEntry</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</a></span></div>
<div class="block">Gets the next trace entry
returns 0=no more entries in this buffer 1=ok to format</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link" target="_blank">IOException</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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>