| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>TraceContext (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: TraceContext"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.jvm.trace.format.api.TraceContext class"> |
| <meta name="keywords" content="traceFormatMajorVersion"> |
| <meta name="keywords" content="traceFormatMinorVersion"> |
| <meta name="keywords" content="INTERNAL"> |
| <meta name="keywords" content="EXTERNAL"> |
| <meta name="keywords" content="BYTE"> |
| <meta name="keywords" content="INT"> |
| <meta name="keywords" content="LONG"> |
| <meta name="keywords" content="SIZE_T"> |
| <meta name="keywords" content="MILLIS2SECONDS"> |
| <meta name="keywords" content="SECONDS2MINUTES"> |
| <meta name="keywords" content="MINUTES2HOURS"> |
| <meta name="keywords" content="HOURS2DAYS"> |
| <meta name="keywords" content="MILLION"> |
| <meta name="keywords" content="messageFile"> |
| <meta name="keywords" content="auxiliaryMessageFiles"> |
| <meta name="keywords" content="setRecordThreadNames()"> |
| <meta name="keywords" content="getRecordThreadNames()"> |
| <meta name="keywords" content="warning()"> |
| <meta name="keywords" content="error()"> |
| <meta name="keywords" content="message()"> |
| <meta name="keywords" content="debug()"> |
| <meta name="keywords" content="setErrorStream()"> |
| <meta name="keywords" content="setWarningStream()"> |
| <meta name="keywords" content="setDebugStream()"> |
| <meta name="keywords" content="setMessageStream()"> |
| <meta name="keywords" content="getVersion()"> |
| <meta name="keywords" content="getVmVersionString()"> |
| <meta name="keywords" content="getHighPrecisionResolution()"> |
| <meta name="keywords" content="getRecordSize()"> |
| <meta name="keywords" content="getHeaderSize()"> |
| <meta name="keywords" content="order()"> |
| <meta name="keywords" content="getTraceType()"> |
| <meta name="keywords" content="setTraceType()"> |
| <meta name="keywords" content="getTotalTracePoints()"> |
| <meta name="keywords" content="getTotalRecords()"> |
| <meta name="keywords" content="getErrorCount()"> |
| <meta name="keywords" content="getWarningCount()"> |
| <meta name="keywords" content="addMessageData()"> |
| <meta name="keywords" content="getPointerSize()"> |
| <meta name="keywords" content="getContext()"> |
| <meta name="keywords" content="addData()"> |
| <meta name="keywords" content="discardedData()"> |
| <meta name="keywords" content="getStartPlatform()"> |
| <meta name="keywords" content="getStartSystem()"> |
| <meta name="keywords" content="getThreads()"> |
| <meta name="keywords" content="getTracepoints()"> |
| <meta name="keywords" content="addThreadToFilter()"> |
| <meta name="keywords" content="setTimeZoneOffset()"> |
| <meta name="keywords" content="formatPointer()"> |
| <meta name="keywords" content="summary()"> |
| <meta name="keywords" content="setDebugLevel()"> |
| <meta name="keywords" content="statistics()"> |
| <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/TraceContext.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </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>Constr | </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> <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.trace.format.api</a></div> |
| <h1 title="Class TraceContext" class="title">Class TraceContext</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.TraceContext</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TraceContext</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></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field.summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Vector.html" title="class or interface in java.util" class="external-link" target="_blank">Vector</a></code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#auxiliaryMessageFiles">auxiliaryMessageFiles</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static int</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#BYTE">BYTE</a></span></code></div> |
| <div class="col-last odd-row-color"> </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="#EXTERNAL">EXTERNAL</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#HOURS2DAYS">HOURS2DAYS</a></span></code></div> |
| <div class="col-last odd-row-color"> </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="#INT">INT</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static int</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#INTERNAL">INTERNAL</a></span></code></div> |
| <div class="col-last odd-row-color"> </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="#LONG">LONG</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="MessageFile.html" title="class in com.ibm.jvm.trace.format.api">MessageFile</a></code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#messageFile">messageFile</a></span></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#MILLION">MILLION</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#MILLIS2SECONDS">MILLIS2SECONDS</a></span></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#MINUTES2HOURS">MINUTES2HOURS</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#SECONDS2MINUTES">SECONDS2MINUTES</a></span></code></div> |
| <div class="col-last odd-row-color"> </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="#SIZE_T">SIZE_T</a></span></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static int</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#traceFormatMajorVersion">traceFormatMajorVersion</a></span></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static int</code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#traceFormatMinorVersion">traceFormatMinorVersion</a></span></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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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><a href="TraceThread.html" title="class in com.ibm.jvm.trace.format.api">TraceThread</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="#addData(byte%5B%5D)">addData</a></span>​(byte[] data)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="TraceThread.html" title="class in com.ibm.jvm.trace.format.api">TraceThread</a></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="#addData(java.io.RandomAccessFile,long)">addData</a></span>​(<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> file, |
| long offset)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#addMessageData(java.io.File)">addMessageData</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> file)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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="#addMessageData(java.io.InputStream)">addMessageData</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> stream)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Adds additional formatting strings to the set provided when the context was created.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#addThreadToFilter(java.lang.Long)">addThreadToFilter</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link" target="_blank">Long</a> threadID)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">This method adds a thread id to the thread filter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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="#debug(java.lang.Object,int,java.lang.Object)">debug</a></span>​(<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> source, |
| int level, |
| <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> message)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Reports a debug message</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#discardedData()">discardedData</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">This method tells the formatter that there was data discarded at this point in |
| the stream of records.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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="#error(java.lang.Object,java.lang.Object)">error</a></span>​(<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> source, |
| <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> message)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Reports an error message</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="#formatPointer(long)">formatPointer</a></span>​(long value)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getContext(byte%5B%5D,int,java.io.File)">getContext</a></span>​(byte[] data, |
| int length, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> messageFile)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getContext(byte%5B%5D,int,java.io.File,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)">getContext</a></span>​(byte[] data, |
| int length, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> messageFile, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> error, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> warning, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> debug)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getContext(byte%5B%5D,int,java.io.InputStream)">getContext</a></span>​(byte[] data, |
| int length, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> messageFile)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Message and warning destinations default to stdout, the error destination defaults to stderr.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getContext(byte%5B%5D,int,java.io.InputStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)">getContext</a></span>​(byte[] data, |
| int length, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> messageFile, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> error, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> warning, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> debug)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">This method constructs a context that can be used to format trace records produced by the VM instance that created the meta-data provided.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getContext(java.nio.ByteBuffer,java.io.File)">getContext</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> messageFile)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getContext(java.nio.ByteBuffer,java.io.File,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)">getContext</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> messageFile, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> error, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> warning, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> debug)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">This method constructs a context that can be used to format trace records produced by the VM instance that created the meta-data provided.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getContext(java.nio.ByteBuffer,java.io.InputStream)">getContext</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> messageFile)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Message and warning destinations default to stdout, the error destination defaults to stderr.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getContext(java.nio.ByteBuffer,java.io.InputStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)">getContext</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> messageFile, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> error, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> warning, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> debug)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">This method constructs a context that can be used to format trace records produced by the VM instance that created the meta-data provided.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</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="#getErrorCount()">getErrorCount</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">The number of errors encountered to date</div> |
| </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="#getHeaderSize()">getHeaderSize</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">Returns the size of the meta-data.</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="#getHeaderSize(java.nio.ByteBuffer)">getHeaderSize</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Constructs a temporary TraceFileHeader from the supplied data and returns it's size |
| offset of the first record.</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/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</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="#getHighPrecisionResolution()">getHighPrecisionResolution</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">This returns the number of high precision ticks per millisecond as calculated based on trace data processed |
| to date.</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="#getPointerSize()">getPointerSize</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">Accessor for the pointer size associated with the trace data</div> |
| </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="#getRecordSize()">getRecordSize</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">The size of the trace records expected by the context</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</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="#getRecordThreadNames()">getRecordThreadNames</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">Answer whether thread names are being captured for inclusion in the |
| information returned by <a href="#summary()"><code>summary()</code></a>.</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/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</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="#getStartPlatform()">getStartPlatform</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">The time of trace initialization in the traced JVM in high precision format |
| This should be used in conjunction with the system start time</div> |
| </div> |
| <div class="col-first odd-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/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></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="#getStartSystem()">getStartSystem</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">The system time of trace initialization in the traced JVM</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/util/Iterator.html" title="class or interface in java.util" class="external-link" target="_blank">Iterator</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="#getThreads()">getThreads</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">This method provides an iterator to walk the set of known threads; those that have not |
| returned trace points that indicate the thread is exiting.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</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="#getTotalRecords()">getTotalRecords</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">The total number of records processed to date</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</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="#getTotalTracePoints()">getTotalTracePoints</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">The total number of trace points returned to date</div> |
| </div> |
| <div class="col-first odd-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/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-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getTracepoints()">getTracepoints</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">This method returns trace points in chronological order on the current data set across threads.</div> |
| </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="#getTraceType()">getTraceType</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">Accessor for the trace type, internal (wraps within a single buffer) or external (no wrapping)</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>float</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="#getVersion()">getVersion</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </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="#getVmVersionString()">getVmVersionString</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">A description of the VM that generated the meta-data with which the context was constructed</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>long</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="#getWarningCount()">getWarningCount</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">The number of warnings encountered to date</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#message(java.lang.Object,java.lang.Object)">message</a></span>​(<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> source, |
| <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> message)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Reports an informational message</div> |
| </div> |
| <div class="col-first odd-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/nio/ByteOrder.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteOrder</a></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="#order()">order</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">The byte order of the trace data</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#setDebugLevel(int)">setDebugLevel</a></span>​(int level)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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="#setDebugStream(java.io.PrintStream)">setDebugStream</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> stream)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Sets the destination for debug messages</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#setErrorStream(java.io.PrintStream)">setErrorStream</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> stream)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Sets the destination for error messages</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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="#setMessageStream(java.io.PrintStream)">setMessageStream</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> stream)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Sets the destination for informational messages</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#setRecordThreadNames(boolean)">setRecordThreadNames</a></span>​(boolean value)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Controls whether thread names are captured for inclusion in the |
| information returned by <a href="#summary()"><code>summary()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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="#setTimeZoneOffset(int)">setTimeZoneOffset</a></span>​(int minutes)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Sets the timezone offset from GMT in +/- minutes to be applied to the time stamp when formatted.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setTraceType(int)">setTraceType</a></span>​(int type)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab6 method-summary-table-tab4 method-summary-table"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">this method is deprecated as it's use implies a problem elsewhere</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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="#setWarningStream(java.io.PrintStream)">setWarningStream</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> stream)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Sets the destination for warning messages</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="#statistics()">statistics</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first odd-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 odd-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 odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</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="#warning(java.lang.Object,java.lang.Object)">warning</a></span>​(<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> source, |
| <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> message)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Reports a warning message</div> |
| </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/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="traceFormatMajorVersion"> |
| <h3>traceFormatMajorVersion</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">traceFormatMajorVersion</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceContext.traceFormatMajorVersion">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="traceFormatMinorVersion"> |
| <h3>traceFormatMinorVersion</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">traceFormatMinorVersion</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceContext.traceFormatMinorVersion">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INTERNAL"> |
| <h3>INTERNAL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">INTERNAL</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceContext.INTERNAL">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EXTERNAL"> |
| <h3>EXTERNAL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">EXTERNAL</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceContext.EXTERNAL">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="BYTE"> |
| <h3>BYTE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">BYTE</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceContext.BYTE">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INT"> |
| <h3>INT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">INT</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceContext.INT">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LONG"> |
| <h3>LONG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">LONG</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceContext.LONG">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SIZE_T"> |
| <h3>SIZE_T</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">SIZE_T</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../../../../constant-values.html#com.ibm.jvm.trace.format.api.TraceContext.SIZE_T">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MILLIS2SECONDS"> |
| <h3>MILLIS2SECONDS</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">MILLIS2SECONDS</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SECONDS2MINUTES"> |
| <h3>SECONDS2MINUTES</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">SECONDS2MINUTES</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MINUTES2HOURS"> |
| <h3>MINUTES2HOURS</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">MINUTES2HOURS</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="HOURS2DAYS"> |
| <h3>HOURS2DAYS</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">HOURS2DAYS</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MILLION"> |
| <h3>MILLION</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">MILLION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="messageFile"> |
| <h3>messageFile</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="MessageFile.html" title="class in com.ibm.jvm.trace.format.api">MessageFile</a></span> <span class="element-name">messageFile</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="auxiliaryMessageFiles"> |
| <h3>auxiliaryMessageFiles</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Vector.html" title="class or interface in java.util" class="external-link" target="_blank">Vector</a></span> <span class="element-name">auxiliaryMessageFiles</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setRecordThreadNames(boolean)"> |
| <h3>setRecordThreadNames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRecordThreadNames</span>​<span class="parameters">(boolean value)</span></div> |
| <div class="block">Controls whether thread names are captured for inclusion in the |
| information returned by <a href="#summary()"><code>summary()</code></a>. |
| |
| By default, thread names are not captured unless enabled via this |
| method. Any previously captured names are discarded when subsequently |
| disabled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - whether thread names should be captured</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRecordThreadNames()"> |
| <h3>getRecordThreadNames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getRecordThreadNames</span>()</div> |
| <div class="block">Answer whether thread names are being captured for inclusion in the |
| information returned by <a href="#summary()"><code>summary()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if thread names are being captured, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="warning(java.lang.Object,java.lang.Object)"> |
| <h3>warning</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">warning</span>​<span class="parameters">(<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> source, |
| <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> message)</span></div> |
| <div class="block">Reports a warning message</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - - the object generating the message</dd> |
| <dd><code>message</code> - - the message to report</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="error(java.lang.Object,java.lang.Object)"> |
| <h3>error</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">error</span>​<span class="parameters">(<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> source, |
| <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> message)</span></div> |
| <div class="block">Reports an error message</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - - the object generating the message</dd> |
| <dd><code>message</code> - - the message to report</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="message(java.lang.Object,java.lang.Object)"> |
| <h3>message</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">message</span>​<span class="parameters">(<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> source, |
| <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> message)</span></div> |
| <div class="block">Reports an informational message</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - - the object generating the message</dd> |
| <dd><code>message</code> - - the message to report</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="debug(java.lang.Object,int,java.lang.Object)"> |
| <h3>debug</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">debug</span>​<span class="parameters">(<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> source, |
| int level, |
| <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> message)</span></div> |
| <div class="block">Reports a debug message</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - - the object generating the message</dd> |
| <dd><code>level</code> - - the debug level of the message</dd> |
| <dd><code>message</code> - - the message to report</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setErrorStream(java.io.PrintStream)"> |
| <h3>setErrorStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setErrorStream</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> stream)</span></div> |
| <div class="block">Sets the destination for error messages</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - - destination</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setWarningStream(java.io.PrintStream)"> |
| <h3>setWarningStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setWarningStream</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> stream)</span></div> |
| <div class="block">Sets the destination for warning messages</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - - destination</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDebugStream(java.io.PrintStream)"> |
| <h3>setDebugStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDebugStream</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> stream)</span></div> |
| <div class="block">Sets the destination for debug messages</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - - destination</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMessageStream(java.io.PrintStream)"> |
| <h3>setMessageStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMessageStream</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> stream)</span></div> |
| <div class="block">Sets the destination for informational messages</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - - destination</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVersion()"> |
| <h3>getVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">float</span> <span class="element-name">getVersion</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVmVersionString()"> |
| <h3>getVmVersionString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">getVmVersionString</span>()</div> |
| <div class="block">A description of the VM that generated the meta-data with which the context was constructed</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- VM description</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHighPrecisionResolution()"> |
| <h3>getHighPrecisionResolution</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">getHighPrecisionResolution</span>()</div> |
| <div class="block">This returns the number of high precision ticks per millisecond as calculated based on trace data processed |
| to date. This value will stabilize over time.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- ticks per millisecond</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRecordSize()"> |
| <h3>getRecordSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRecordSize</span>()</div> |
| <div class="block">The size of the trace records expected by the context</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- size in bytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeaderSize()"> |
| <h3>getHeaderSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getHeaderSize</span>()</div> |
| <div class="block">Returns the size of the meta-data. This allows a file processor to skip to the |
| offset of the first record.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the length of the meta-data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeaderSize(java.nio.ByteBuffer)"> |
| <h3>getHeaderSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getHeaderSize</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data)</span></div> |
| <div class="block">Constructs a temporary TraceFileHeader from the supplied data and returns it's size |
| offset of the first record.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the length of the meta-data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="order()"> |
| <h3>order</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteOrder.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteOrder</a></span> <span class="element-name">order</span>()</div> |
| <div class="block">The byte order of the trace data</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- a ByteOrder</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTraceType()"> |
| <h3>getTraceType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getTraceType</span>()</div> |
| <div class="block">Accessor for the trace type, internal (wraps within a single buffer) or external (no wrapping)</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- trace type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTraceType(int)"> |
| <h3>setTraceType</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link" target="_blank">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTraceType</span>​<span class="parameters">(int type)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">this method is deprecated as it's use implies a problem elsewhere</div> |
| </div> |
| <div class="block">This forces the trace to a given type. This should only be necessary if you have metadata from |
| a VM when no subscribers were attached and data from a subscriber that was registered afterwards. |
| The inverted case could be true as well, but is much less likely to occur. |
| |
| If you're calling this then you should think about altering the sequence of calls used to get the |
| metadata and trace data.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - - the type of the trace data to process, either TraceContext.INTERNAL or TraceContext.EXTERNAL</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTotalTracePoints()"> |
| <h3>getTotalTracePoints</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getTotalTracePoints</span>()</div> |
| <div class="block">The total number of trace points returned to date</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- number of trace points</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTotalRecords()"> |
| <h3>getTotalRecords</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getTotalRecords</span>()</div> |
| <div class="block">The total number of records processed to date</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- number of records</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getErrorCount()"> |
| <h3>getErrorCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getErrorCount</span>()</div> |
| <div class="block">The number of errors encountered to date</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- number of errors</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWarningCount()"> |
| <h3>getWarningCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getWarningCount</span>()</div> |
| <div class="block">The number of warnings encountered to date</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- number of warnings</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMessageData(java.io.File)"> |
| <h3>addMessageData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addMessageData</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> file)</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> |
| <dt>See Also:</dt> |
| <dd><a href="#addMessageData(java.io.InputStream)"><code>addMessageData(InputStream)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMessageData(java.io.InputStream)"> |
| <h3>addMessageData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addMessageData</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> stream)</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">Adds additional formatting strings to the set provided when the context was created.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - - input stream for accessing formatting data</dd> |
| <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="getPointerSize()"> |
| <h3>getPointerSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getPointerSize</span>()</div> |
| <div class="block">Accessor for the pointer size associated with the trace data</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- pointer size in bytes (4 or 8)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(java.nio.ByteBuffer,java.io.File)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></span> <span class="element-name">getContext</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> messageFile)</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>Returns:</dt> |
| <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> |
| <dt>See Also:</dt> |
| <dd><a href="#getContext(java.nio.ByteBuffer,java.io.InputStream)"><code>getContext(ByteBuffer, InputStream)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(byte[],int,java.io.File)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></span> <span class="element-name">getContext</span>​<span class="parameters">(byte[] data, |
| int length, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> messageFile)</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> |
| <dt>See Also:</dt> |
| <dd><a href="#getContext(java.nio.ByteBuffer,java.io.InputStream)"><code>getContext(ByteBuffer, InputStream)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(byte[],int,java.io.File,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></span> <span class="element-name">getContext</span>​<span class="parameters">(byte[] data, |
| int length, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> messageFile, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> error, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> warning, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> debug)</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> |
| <dt>See Also:</dt> |
| <dd><a href="#getContext(byte%5B%5D,int,java.io.InputStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)"><code>getContext(byte[], int, InputStream, PrintStream, PrintStream, PrintStream, PrintStream)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(java.nio.ByteBuffer,java.io.InputStream)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></span> <span class="element-name">getContext</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> messageFile)</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">Message and warning destinations default to stdout, the error destination defaults to stderr.</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> |
| <dt>See Also:</dt> |
| <dd><a href="#getContext(byte%5B%5D,int,java.io.InputStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)"><code>getContext(byte[], int, InputStream, PrintStream, PrintStream, PrintStream, PrintStream)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(byte[],int,java.io.InputStream)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></span> <span class="element-name">getContext</span>​<span class="parameters">(byte[] data, |
| int length, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> messageFile)</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">Message and warning destinations default to stdout, the error destination defaults to stderr.</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> |
| <dt>See Also:</dt> |
| <dd><a href="#getContext(byte%5B%5D,int,java.io.InputStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)"><code>getContext(byte[], int, InputStream, PrintStream, PrintStream, PrintStream, PrintStream)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(byte[],int,java.io.InputStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></span> <span class="element-name">getContext</span>​<span class="parameters">(byte[] data, |
| int length, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> messageFile, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> error, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> warning, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> debug)</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">This method constructs a context that can be used to format trace records produced by the VM instance that created the meta-data provided. |
| The message file is used to format trace points into a human readable form and the print streams provided are where messages of that type are written to</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>data</code> - - trace meta-data</dd> |
| <dd><code>length</code> - - the length of the meta-data in the array</dd> |
| <dd><code>messageFile</code> - - a file containing format strings</dd> |
| <dd><code>message</code> - - informational message destination</dd> |
| <dd><code>error</code> - - error message destination</dd> |
| <dd><code>warning</code> - - warning message destination</dd> |
| <dd><code>debug</code> - - debug message destination</dd> |
| <dt>Returns:</dt> |
| <dd>- a context to use for formatting trace records</dd> |
| <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> - - if the message data can't be accessed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext(java.nio.ByteBuffer,java.io.File,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></span> <span class="element-name">getContext</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link" target="_blank">File</a> messageFile, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> error, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> warning, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> debug)</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">This method constructs a context that can be used to format trace records produced by the VM instance that created the meta-data provided. |
| The message file is used to format trace points into a human readable form and the print streams provided are where messages of that type are written to</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>data</code> - - trace meta-data</dd> |
| <dd><code>messageFile</code> - - a file containing format strings</dd> |
| <dd><code>message</code> - - informational message destination</dd> |
| <dd><code>error</code> - - error message destination</dd> |
| <dd><code>warning</code> - - warning message destination</dd> |
| <dd><code>debug</code> - - debug message destination</dd> |
| <dt>Returns:</dt> |
| <dd>- a context to use for formatting trace records</dd> |
| <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="getContext(java.nio.ByteBuffer,java.io.InputStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream,java.io.PrintStream)"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="TraceContext.html" title="class in com.ibm.jvm.trace.format.api">TraceContext</a></span> <span class="element-name">getContext</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link" target="_blank">ByteBuffer</a> data, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link" target="_blank">InputStream</a> messageFile, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> message, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> error, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> warning, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a> debug)</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">This method constructs a context that can be used to format trace records produced by the VM instance that created the meta-data provided. |
| The message file is used to format trace points into a human readable form and the print streams provided are where messages of that type are written to</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>data</code> - - trace meta-data</dd> |
| <dd><code>messageFile</code> - - an input stream providing access to format strings</dd> |
| <dd><code>message</code> - - informational message destination</dd> |
| <dd><code>error</code> - - error message destination</dd> |
| <dd><code>warning</code> - - warning message destination</dd> |
| <dd><code>debug</code> - - debug message destination</dd> |
| <dt>Returns:</dt> |
| <dd>- a context to use for formatting trace records</dd> |
| <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="addData(java.io.RandomAccessFile,long)"> |
| <h3>addData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TraceThread.html" title="class in com.ibm.jvm.trace.format.api">TraceThread</a></span> <span class="element-name">addData</span>​<span class="parameters">(<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> file, |
| long 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></span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>file</code> - - file containing trace data</dd> |
| <dd><code>offset</code> - - the offset in the file of the buffer</dd> |
| <dt>Returns:</dt> |
| <dd>- the thread that generated the buffer</dd> |
| <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> |
| <dt>See Also:</dt> |
| <dd><code>addData(TraceRecord)</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addData(byte[])"> |
| <h3>addData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TraceThread.html" title="class in com.ibm.jvm.trace.format.api">TraceThread</a></span> <span class="element-name">addData</span>​<span class="parameters">(byte[] data)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>data</code> - - a trace buffer generated by the JVM corresponding the context</dd> |
| <dt>Returns:</dt> |
| <dd>- the thread that generated the buffer</dd> |
| <dt>See Also:</dt> |
| <dd><code>addData(TraceRecord)</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="discardedData()"> |
| <h3>discardedData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">discardedData</span>()</div> |
| <div class="block">This method tells the formatter that there was data discarded at this point in |
| the stream of records. This has the affect of discarding any trace point fragments |
| that are awaiting data for completion across all threads. When a trace point iterator |
| encounters one of the locations where data was discarded it will throw a MissingDataException |
| as for records discarded by the trace engine. |
| |
| This makes the assumption that the records are being supplied chronologically.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartPlatform()"> |
| <h3>getStartPlatform</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">getStartPlatform</span>()</div> |
| <div class="block">The time of trace initialization in the traced JVM in high precision format |
| This should be used in conjunction with the system start time</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- high precision start time</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartSystem()"> |
| <h3>getStartSystem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">getStartSystem</span>()</div> |
| <div class="block">The system time of trace initialization in the traced JVM</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- start time</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThreads()"> |
| <h3>getThreads</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">getThreads</span>()</div> |
| <div class="block">This method provides an iterator to walk the set of known threads; those that have not |
| returned trace points that indicate the thread is exiting. This iterator may be invalidated |
| by adding new trace data to the context.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>- iterator over non-dead threads</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTracepoints()"> |
| <h3>getTracepoints</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">getTracepoints</span>()</div> |
| <div class="block">This method returns trace points in chronological order on the current data set across threads. |
| This operates on the data available at the time the method is called. If new data is added |
| the oldest trace point from the expanded data set will be returned, irrespective if newer |
| trace points have already been returned.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addThreadToFilter(java.lang.Long)"> |
| <h3>addThreadToFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addThreadToFilter</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link" target="_blank">Long</a> threadID)</span></div> |
| <div class="block">This method adds a thread id to the thread filter. Only those threads in the filter will have data |
| returned via any of the iterators.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>threadID</code> - - the id of the thread to include in the filter</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTimeZoneOffset(int)"> |
| <h3>setTimeZoneOffset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTimeZoneOffset</span>​<span class="parameters">(int minutes)</span></div> |
| <div class="block">Sets the timezone offset from GMT in +/- minutes to be applied to the time stamp when formatted.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>minutes</code> - - timezone offset in minutes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="formatPointer(long)"> |
| <h3>formatPointer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">formatPointer</span>​<span class="parameters">(long value)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="summary()"> |
| <h3>summary</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">summary</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDebugLevel(int)"> |
| <h3>setDebugLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDebugLevel</span>​<span class="parameters">(int level)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="statistics()"> |
| <h3>statistics</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">statistics</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/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
