api/jdk16/openj9.traceformat/com/ibm/jvm/trace/format/api/TraceRecord.html - gerrit/www.eclipse.org/openj9/docs - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (16) -->
 <title>TraceRecord (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.trace.format.api, class: TraceRecord">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="com.ibm.jvm.trace.format.api.TraceRecord class">
 <meta name="keywords" content="TRACERECORD_HEADER_SIZE">
 <meta name="keywords" content="appendToStream()">
 <meta name="keywords" content="toString()">
 <meta name="keywords" content="summary()">
 <meta name="keywords" content="compareTo()">
 <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/TraceRecord.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><a href="#field.detail">Field</a>&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.trace.format.api</a></div>
 <h1 title="Class TraceRecord" class="title">Class TraceRecord</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.jvm.trace.format.api.TraceRecord</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>&lt;<a href="TraceRecord.html" title="class in com.ibm.jvm.trace.format.api">TraceRecord</a>&gt;</code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TraceRecord</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>
 implements <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>&lt;<a href="TraceRecord.html" title="class in com.ibm.jvm.trace.format.api">TraceRecord</a>&gt;</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>static int</code></div>
 <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#TRACERECORD_HEADER_SIZE">TRACERECORD_HEADER_SIZE</a></span></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </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><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.jvm.trace.format.api.TraceContext,byte%5B%5D)">TraceRecord</a></span>&#8203;(<a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a>&nbsp;context,
  byte[]&nbsp;data)</code></div>
 <div class="col-last even-row-color">
 <div class="block">This will create a TraceRecord from a byte array.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(com.ibm.jvm.trace.format.api.TraceContext,java.io.RandomAccessFile,long)">TraceRecord</a></span>&#8203;(<a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a>&nbsp;context,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/RandomAccessFile.html" title="class or interface in java.io" class="external-link" target="_blank">RandomAccessFile</a>&nbsp;file,
  long&nbsp;offset)</code></div>
 <div class="col-last odd-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>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="#appendToStream(com.ibm.jvm.trace.format.api.ByteStream,boolean)">appendToStream</a></span>&#8203;(<a href="ByteStream.html" title="class in com.ibm.jvm.trace.format.api">ByteStream</a>&nbsp;stream,
  boolean&nbsp;newThread)</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
 <div class="block">Appends the body of the data from this trace record to the stream IN
  CHRONOLOGICAL ORDER.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</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="#compareTo(com.ibm.jvm.trace.format.api.TraceRecord)">compareTo</a></span>&#8203;(<a href="TraceRecord.html" title="class in com.ibm.jvm.trace.format.api">TraceRecord</a>&nbsp;other)</code></div>
 <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
 <div class="block">Compares this object with the specified object for order.</div>
 </div>
 <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><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-tab4 method-summary-table"><code><span class="member-name-link"><a href="#summary()">summary</a></span>()</code></div>
 <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
 </div>
 </div>
 </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">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field.detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="TRACERECORD_HEADER_SIZE">
 <h3>TRACERECORD_HEADER_SIZE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">TRACERECORD_HEADER_SIZE</span></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceRecord.TRACERECORD_HEADER_SIZE">Constant Field Values</a></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="&lt;init&gt;(com.ibm.jvm.trace.format.api.TraceContext,byte[])">
 <h3>TraceRecord</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TraceRecord</span>&#8203;<span class="parameters">(<a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a>&nbsp;context,
  byte[]&nbsp;data)</span>
             throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></span></div>
 <div class="block">This will create a TraceRecord from a byte array. The byte array must be of the correct length
  for a trace record in this context.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>data</code> - </dd>
 <dd><code>context</code> - </dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(com.ibm.jvm.trace.format.api.TraceContext,java.io.RandomAccessFile,long)">
 <h3>TraceRecord</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TraceRecord</span>&#8203;<span class="parameters">(<a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a>&nbsp;context,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/RandomAccessFile.html" title="class or interface in java.io" class="external-link" target="_blank">RandomAccessFile</a>&nbsp;file,
  long&nbsp;offset)</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>,
 <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</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>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</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="appendToStream(com.ibm.jvm.trace.format.api.ByteStream,boolean)">
 <h3>appendToStream</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">appendToStream</span>&#8203;<span class="parameters">(<a href="ByteStream.html" title="class in com.ibm.jvm.trace.format.api">ByteStream</a>&nbsp;stream,
  boolean&nbsp;newThread)</span></div>
 <div class="block">Appends the body of the data from this trace record to the stream IN
  CHRONOLOGICAL ORDER. This means that if the buffer wrapped at all the
  data will be reordered so that reading from the bytestream will return
  data correctly ordered for reading as a continuous temporal stream.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>stream</code> - - the stream onto which the record should be appended</dd>
 <dd><code>newThread</code> - - indicates whether this is the first record on a thread</dd>
 <dt>Returns:</dt>
 <dd>the number of bytes appended</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="summary()">
 <h3>summary</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<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">summary</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="compareTo(com.ibm.jvm.trace.format.api.TraceRecord)">
 <h3>compareTo</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">compareTo</span>&#8203;<span class="parameters">(<a href="TraceRecord.html" title="class in com.ibm.jvm.trace.format.api">TraceRecord</a>&nbsp;other)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Comparable</a></code></span></div>
 <div class="block">Compares this object with the specified object for order.  Returns a
  negative integer, zero, or a positive integer as this object is less
  than, equal to, or greater than the specified object.

  <p>The implementor must ensure
  <code>sgn(x.compareTo(y)) == -sgn(y.compareTo(x))</code>
  for all <code>x</code> and <code>y</code>.  (This
  implies that <code>x.compareTo(y)</code> must throw an exception iff
  <code>y.compareTo(x)</code> throws an exception.)

  <p>The implementor must also ensure that the relation is transitive:
  <code>(x.compareTo(y) &gt; 0 &amp;&amp; y.compareTo(z) &gt; 0)</code> implies
  <code>x.compareTo(z) &gt; 0</code>.

  <p>Finally, the implementor must ensure that <code>x.compareTo(y)==0</code>
  implies that <code>sgn(x.compareTo(z)) == sgn(y.compareTo(z))</code>, for
  all <code>z</code>.

  <p>It is strongly recommended, but <i>not</i> strictly required that
  <code>(x.compareTo(y)==0) == (x.equals(y))</code>.  Generally speaking, any
  class that implements the <code>Comparable</code> interface and violates
  this condition should clearly indicate this fact.  The recommended
  language is "Note: this class has a natural ordering that is
  inconsistent with equals."

  <p>In the foregoing description, the notation
  <code>sgn(</code><i>expression</i><code>)</code> designates the mathematical
  <i>signum</i> function, which is defined to return one of <code>-1</code>,
  <code>0</code>, or <code>1</code> according to whether the value of
  <i>expression</i> is negative, zero, or positive, respectively.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang" class="external-link" target="_blank">compareTo</a></code>&nbsp;in interface&nbsp;<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>&lt;<a href="TraceRecord.html" title="class in com.ibm.jvm.trace.format.api">TraceRecord</a>&gt;</code></dd>
 <dt>Parameters:</dt>
 <dd><code>other</code> - the object to be compared.</dd>
 <dt>Returns:</dt>
 <dd>a negative integer, zero, or a positive integer as this object
           is less than, equal to, or greater than the specified object.</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>