| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TraceFileHeader (OpenJ9 JDK 17)</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: TraceFileHeader"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.jvm.format.TraceFileHeader class"> |
| <meta name="keywords" content="traceSection"> |
| <meta name="keywords" content="INTERNAL"> |
| <meta name="keywords" content="EXTERNAL"> |
| <meta name="keywords" content="processTraceBufferHeaders()"> |
| <meta name="keywords" content="summarize()"> |
| <meta name="keywords" content="getLength()"> |
| <meta name="keywords" content="getBufferSize()"> |
| <meta name="keywords" content="formatFileName()"> |
| <meta name="keywords" content="getVMLevel()"> |
| <meta name="keywords" content="getNextFormatFileName()"> |
| <meta name="keywords" content="isUTE()"> |
| <meta name="keywords" content="getTraceDataStart()"> |
| <meta name="keywords" content="getVMVersion()"> |
| <meta name="keywords" content="getVMStartUpParameters()"> |
| <meta name="keywords" content="getTraceParameters()"> |
| <meta name="keywords" content="getSysProcessorInfo()"> |
| <meta name="keywords" content="getJVMStartedMillis()"> |
| <meta name="keywords" content="getLastBufferWriteMillis()"> |
| <meta name="keywords" content="getFirstTracePointMillis()"> |
| <meta name="keywords" content="getLastTracePointMillis()"> |
| <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.6.0.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 17</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/TraceFileHeader.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> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <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" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" 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> <a href="../../../../module-summary.html">openj9.traceformat</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.jvm.format</a></div> |
| <h1 title="Class TraceFileHeader" class="title">Class TraceFileHeader</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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.format.TraceFileHeader</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">TraceFileHeader</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/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="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></span></div> |
| <div class="block">Encapsulates the header for a trace file.</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 static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#EXTERNAL" class="member-name-link">EXTERNAL</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="#INTERNAL" class="member-name-link">INTERNAL</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="TraceSection.html" title="class in com.ibm.jvm.format">TraceSection</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#traceSection" class="member-name-link">traceSection</a></code></div> |
| <div class="col-last even-row-color"> </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 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><a href="#%3Cinit%3E(com.ibm.jvm.format.TraceFile)" class="member-name-link">TraceFileHeader</a><wbr>(<a href="TraceFile.html" title="class in com.ibm.jvm.format">TraceFile</a> traceFile)</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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 method-summary-table-tab2 method-summary-table-tab4"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatFileName()" class="member-name-link">formatFileName</a>()</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>protected final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBufferSize()" class="member-name-link">getBufferSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">returns the size of the buffers in the associated trace file</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFirstTracePointMillis()" class="member-name-link">getFirstTracePointMillis</a>()</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>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJVMStartedMillis()" class="member-name-link">getJVMStartedMillis</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLastBufferWriteMillis()" class="member-name-link">getLastBufferWriteMillis</a>()</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>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLastTracePointMillis()" class="member-name-link">getLastTracePointMillis</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLength()" class="member-name-link">getLength</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">returns the length of this file header</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNextFormatFileName(java.lang.String)" class="member-name-link">getNextFormatFileName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> previous)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSysProcessorInfo()" class="member-name-link">getSysProcessorInfo</a>()</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>final long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTraceDataStart()" class="member-name-link">getTraceDataStart</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTraceParameters()" class="member-name-link">getTraceParameters</a>()</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>protected final <a href="https://docs.oracle.com/en/java/javase/17/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVMLevel()" class="member-name-link">getVMLevel</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/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 method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVMStartUpParameters()" class="member-name-link">getVMStartUpParameters</a>()</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><a href="https://docs.oracle.com/en/java/javase/17/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVMVersion()" class="member-name-link">getVMVersion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static final boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isUTE()" class="member-name-link">isUTE</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">returns true if a UTE trace file is being processed</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#processTraceBufferHeaders()" class="member-name-link">processTraceBufferHeaders</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#summarize(java.io.BufferedWriter)" class="member-name-link">summarize</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/BufferedWriter.html" title="class or interface in java.io" class="external-link" target="_blank">BufferedWriter</a> out)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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="traceSection"> |
| <h3>traceSection</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="TraceSection.html" title="class in com.ibm.jvm.format">TraceSection</a></span> <span class="element-name">traceSection</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INTERNAL"> |
| <h3>INTERNAL</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">INTERNAL</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#com.ibm.jvm.format.TraceFileHeader.INTERNAL">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EXTERNAL"> |
| <h3>EXTERNAL</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">EXTERNAL</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#com.ibm.jvm.format.TraceFileHeader.EXTERNAL">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>(com.ibm.jvm.format.TraceFile)"> |
| <h3>TraceFileHeader</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">TraceFileHeader</span><wbr><span class="parameters">(<a href="TraceFile.html" title="class in com.ibm.jvm.format">TraceFile</a> traceFile)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/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/17/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="processTraceBufferHeaders()"> |
| <h3>processTraceBufferHeaders</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">void</span> <span class="element-name">processTraceBufferHeaders</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/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/17/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="summarize(java.io.BufferedWriter)"> |
| <h3>summarize</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">void</span> <span class="element-name">summarize</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/BufferedWriter.html" title="class or interface in java.io" class="external-link" target="_blank">BufferedWriter</a> out)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/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/17/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="getLength()"> |
| <h3>getLength</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">long</span> <span class="element-name">getLength</span>()</div> |
| <div class="block">returns the length of this file header</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a long</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBufferSize()"> |
| <h3>getBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">int</span> <span class="element-name">getBufferSize</span>()</div> |
| <div class="block">returns the size of the buffers in the associated trace file</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an int</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="formatFileName()"> |
| <h3>formatFileName</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">formatFileName</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVMLevel()"> |
| <h3>getVMLevel</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">getVMLevel</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNextFormatFileName(java.lang.String)"> |
| <h3>getNextFormatFileName</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">getNextFormatFileName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> previous)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isUTE()"> |
| <h3>isUTE</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">boolean</span> <span class="element-name">isUTE</span>()</div> |
| <div class="block">returns true if a UTE trace file is being processed</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a boolean</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTraceDataStart()"> |
| <h3>getTraceDataStart</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">long</span> <span class="element-name">getTraceDataStart</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVMVersion()"> |
| <h3>getVMVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">getVMVersion</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html#getVMVersion()">getVMVersion</a></code> in interface <code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a String representation of the JVM that produced the current TraceFile, null |
| if no valid data.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVMStartUpParameters()"> |
| <h3>getVMStartUpParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]</span> <span class="element-name">getVMStartUpParameters</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html#getVMStartUpParameters()">getVMStartUpParameters</a></code> in interface <code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a String array representation of the startup parameters that were used to start |
| the JVM that produced the current TraceFile, null if no valid data.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTraceParameters()"> |
| <h3>getTraceParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]</span> <span class="element-name">getTraceParameters</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html#getTraceParameters()">getTraceParameters</a></code> in interface <code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a String array representation of the Trace startup parameters that were used to start |
| the JVM that produced the current TraceFile, null if no valid data.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSysProcessorInfo()"> |
| <h3>getSysProcessorInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]</span> <span class="element-name">getSysProcessorInfo</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html#getSysProcessorInfo()">getSysProcessorInfo</a></code> in interface <code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a String array representation of the system on which the JVM that produced |
| the current TraceFile was run, null if no valid data.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJVMStartedMillis()"> |
| <h3>getJVMStartedMillis</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getJVMStartedMillis</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html#getJVMStartedMillis()">getJVMStartedMillis</a></code> in interface <code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the millisecond time at which the JVM that produced the current TraceFile was |
| started. Returns -1 if no valid data.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLastBufferWriteMillis()"> |
| <h3>getLastBufferWriteMillis</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLastBufferWriteMillis</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html#getLastBufferWriteMillis()">getLastBufferWriteMillis</a></code> in interface <code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the millisecond time at which the JVM that produced the current TraceFile wrote |
| its most recent TracePoint before the production of the current TraceFile. Returns -1 if |
| no valid data.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFirstTracePointMillis()"> |
| <h3>getFirstTracePointMillis</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getFirstTracePointMillis</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html#getFirstTracePointMillis()">getFirstTracePointMillis</a></code> in interface <code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the millisecond time of the first TracePoint in the current TraceFile. This may |
| not be the first TracePoint that the JVM produced. Returns -1 if no valid data.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLastTracePointMillis()"> |
| <h3>getLastTracePointMillis</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLastTracePointMillis</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../trace/TraceFileHeader.html#getLastTracePointMillis()">getLastTracePointMillis</a></code> in interface <code><a href="../trace/TraceFileHeader.html" title="interface in com.ibm.jvm.trace">TraceFileHeader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the millisecond time of the last TracePoint in the current TraceFile. This may |
| not be the last TracePoint that the JVM produced. Returns -1 if no valid data.</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> |
