Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk16 / openj9.traceformat / com / ibm / jvm / format / Util.html
blob: b87848722d72aa25cd6795db18ad5e3d539bf379 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>Util (OpenJ9 JDK 16)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: module: openj9.traceformat, package: com.ibm.jvm.format, class: Util">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.jvm.format.Util class">
<meta name="keywords" content="BYTE">
<meta name="keywords" content="INT">
<meta name="keywords" content="LONG">
<meta name="keywords" content="SUM_TAB">
<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="initStatics()">
<meta name="keywords" content="putThreadID()">
<meta name="keywords" content="findThreadID()">
<meta name="keywords" content="putComponent()">
<meta name="keywords" content="findComponentAndType()">
<meta name="keywords" content="constructUnsignedLong()">
<meta name="keywords" content="constructTraceID()">
<meta name="keywords" content="constructUnsignedInt()">
<meta name="keywords" content="constructUnsignedByte()">
<meta name="keywords" content="constructString()">
<meta name="keywords" content="escapeControlCharacters()">
<meta name="keywords" content="setProperty()">
<meta name="keywords" content="getProperty()">
<meta name="keywords" content="padBuffer()">
<meta name="keywords" content="formatAsHexString()">
<meta name="keywords" content="convertEndian()">
<meta name="keywords" content="convertAndCheckEyecatcher()">
<meta name="keywords" content="setBigEndian()">
<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/Util.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../module-summary.html">openj9.traceformat</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.jvm.format</a></div>
<h1 title="Class Util" class="title">Class Util</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.format.Util</div>
</div>
<section class="description">
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Util</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>
<div class="block">Provides various utility functions needed by the trace formatter</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#BYTE">BYTE</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</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">&nbsp;</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="#INT">INT</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</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="#LONG">LONG</a></span></code></div>
<div class="col-last odd-row-color">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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/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"><code><span class="member-name-link"><a href="#SUM_TAB">SUM_TAB</a></span></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method.summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#constructString(byte%5B%5D,int)">constructString</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Constructs a string from an array of bytes, encoding is as specified in the properties</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#constructString(byte%5B%5D,int,int)">constructString</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset,
int&nbsp;count)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Constructs a string from an array of bytes with a count, encoding is as specified in the properties</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#constructString(byte%5B%5D,int,int,java.lang.String)">constructString</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset,
int&nbsp;count,
<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>&nbsp;enc)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Constructs a string from an array of bytes with an offset and count,
with the specified encoding (ASCII or EBCDIC).</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#constructString(byte%5B%5D,int,java.lang.String)">constructString</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset,
<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>&nbsp;enc)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Constructs a string from an array of bytes, with the specified encoding (ASCII or EBCDIC?)</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static int</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="#constructTraceID(byte%5B%5D,int)">constructTraceID</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static int</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="#constructUnsignedByte(byte%5B%5D,int)">constructUnsignedByte</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static long</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="#constructUnsignedInt(byte%5B%5D,int)">constructUnsignedInt</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><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 method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#constructUnsignedLong(byte%5B%5D,int)">constructUnsignedLong</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Construct a BigInteger from an array of bytes.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><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 method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#constructUnsignedLong(byte%5B%5D,int,int)">constructUnsignedLong</a></span>&#8203;(byte[]&nbsp;data,
int&nbsp;offset,
int&nbsp;numBytes)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Construct a BigInteger from an array of bytes.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertAndCheckEyecatcher(int)">convertAndCheckEyecatcher</a></span>&#8203;(int&nbsp;eyecatcher)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static int</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="#convertEndian(int)">convertEndian</a></span>&#8203;(int&nbsp;in)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#escapeControlCharacters(java.lang.String)">escapeControlCharacters</a></span>&#8203;(<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>&nbsp;string)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Escapes control characters in the given string.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#escapeControlCharacters(java.lang.String,java.lang.String)">escapeControlCharacters</a></span>&#8203;(<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>&nbsp;string,
<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>&nbsp;encoding)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Escapes control characters in the given string.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static boolean</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="#findComponentAndType(java.lang.String,java.lang.String)">findComponentAndType</a></span>&#8203;(<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>&nbsp;comp,
<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>&nbsp;type)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">determines if a particular component and type is to be formatted</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static boolean</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="#findThreadID(java.lang.Long)">findThreadID</a></span>&#8203;(<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>&nbsp;threadID)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">retrieve whether of not the given id is in a hashtable.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#formatAsHexString(long)">formatAsHexString</a></span>&#8203;(long&nbsp;number)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Formats a number as a hex string, prefixing the "0x"
radix specifier so that it can be unambiguously
interpreted as a hex string.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getProperty(java.lang.String)">getProperty</a></span>&#8203;(<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>&nbsp;key)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">gets an the value property that affecting behavior of the formatter</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static <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-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getProperty(java.lang.String,java.lang.String)">getProperty</a></span>&#8203;(<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>&nbsp;key,
<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>&nbsp;defaultValue)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">gets an the value property that affecting behavior of the formatter, if no such
property is set the default value is returned</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static void</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="#initStatics()">initStatics</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Initializes static variables.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static void</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="#padBuffer(java.lang.StringBuffer,int,char)">padBuffer</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link" target="_blank">StringBuffer</a>&nbsp;sb,
int&nbsp;i,
char&nbsp;c)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static void</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="#padBuffer(java.lang.StringBuffer,int,char,boolean)">padBuffer</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link" target="_blank">StringBuffer</a>&nbsp;sb,
int&nbsp;i,
char&nbsp;c,
boolean&nbsp;leftJustified)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static void</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="#putComponent(java.lang.String)">putComponent</a></span>&#8203;(<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>&nbsp;comp)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">puts a component name into a hashtable telling the formatter that this component
is one that should be traced.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static void</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="#putComponent(java.lang.String,java.util.Vector)">putComponent</a></span>&#8203;(<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>&nbsp;comp,
<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>&nbsp;types)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">puts a component name into a hashtable telling the formatter that this component
is one that should be traced.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static void</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="#putThreadID(java.lang.Long)">putThreadID</a></span>&#8203;(<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>&nbsp;threadID)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">puts a thread ID into a hashtable telling the formatter that this thread ID
is one that should be traced</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static void</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="#setBigEndian(boolean)">setBigEndian</a></span>&#8203;(boolean&nbsp;endian)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>protected static void</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="#setProperty(java.lang.String,java.lang.String)">setProperty</a></span>&#8203;(<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>&nbsp;key,
<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>&nbsp;val)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">sets an property that affects the behavior of the formatter</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field.detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="BYTE">
<h3>BYTE</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">BYTE</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.jvm.format.Util.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">protected static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">INT</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.jvm.format.Util.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">protected static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">LONG</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.jvm.format.Util.LONG">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SUM_TAB">
<h3>SUM_TAB</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">SUM_TAB</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../constant-values.html#com.ibm.jvm.format.Util.SUM_TAB">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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<span class="element-name">MILLION</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="initStatics()">
<h3>initStatics</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">initStatics</span>()</div>
<div class="block">Initializes static variables.
<p>This is called each time the TraceFormatter is started, from the initStatics()
method in TraceFormat.java</p></div>
</section>
</li>
<li>
<section class="detail" id="putThreadID(java.lang.Long)">
<h3>putThreadID</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">putThreadID</span>&#8203;<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>&nbsp;threadID)</span></div>
<div class="block">puts a thread ID into a hashtable telling the formatter that this thread ID
is one that should be traced</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>threadID</code> - a string representation of a hexidecimal thread id</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="findThreadID(java.lang.Long)">
<h3>findThreadID</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">findThreadID</span>&#8203;<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>&nbsp;threadID)</span></div>
<div class="block">retrieve whether of not the given id is in a hashtable. if the table is null that means
that no ids were added, since the default behavior is all id this returns true</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>threadID</code> - a string representation of a hexidecimal thread id</dd>
<dt>Returns:</dt>
<dd>a boolean that is true if the id was added to the table or if the table is null</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="putComponent(java.lang.String)">
<h3>putComponent</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">putComponent</span>&#8203;<span class="parameters">(<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>&nbsp;comp)</span></div>
<div class="block">puts a component name into a hashtable telling the formatter that this component
is one that should be traced. In this case all types of entries are formatted for this
component</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>comp</code> - a string representation of a component in the jvm</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="putComponent(java.lang.String,java.util.Vector)">
<h3>putComponent</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">putComponent</span>&#8203;<span class="parameters">(<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>&nbsp;comp,
<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>&nbsp;types)</span></div>
<div class="block">puts a component name into a hashtable telling the formatter that this component
is one that should be traced. In this case only the types of entries specified in types
are formatted for this component</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>comp</code> - a string representation of a component in the jvm</dd>
<dd><code>types</code> - a vector of string for the type of trace entries to format (ie, Entry, Exit, Exception, etc)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="findComponentAndType(java.lang.String,java.lang.String)">
<h3>findComponentAndType</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">findComponentAndType</span>&#8203;<span class="parameters">(<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>&nbsp;comp,
<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>&nbsp;type)</span></div>
<div class="block">determines if a particular component and type is to be formatted</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>comp</code> - a string representation of a component in the jvm</dd>
<dd><code>types</code> - a string for the type of trace entry to format (ie, Entry, Exit, Exception, etc)</dd>
<dt>Returns:</dt>
<dd>a boolean that is true if this component and type was added to the table or if the table is null</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="constructUnsignedLong(byte[],int)">
<h3>constructUnsignedLong</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<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>&nbsp;<span class="element-name">constructUnsignedLong</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset)</span></div>
<div class="block">Construct a BigInteger from an array of bytes. BigIntegers are used to get around problems
caused by the lack of unsigned primitive type.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - an array of bytes</dd>
<dd><code>offset</code> - offset to the first byte to use to create the BigInteger</dd>
<dt>Returns:</dt>
<dd>a positive BigInteger constructed from the byte array</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="constructUnsignedLong(byte[],int,int)">
<h3>constructUnsignedLong</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<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>&nbsp;<span class="element-name">constructUnsignedLong</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset,
int&nbsp;numBytes)</span></div>
<div class="block">Construct a BigInteger from an array of bytes. BigIntegers are used to get around problems
caused by the lack of unsigned primitive type.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - an array of bytes</dd>
<dd><code>offset</code> - offset to the first byte to use to create the BigInteger</dd>
<dd><code>numBytes</code> - the length of this BigInteger in bytes</dd>
<dt>Returns:</dt>
<dd>a positive BigInteger constructed from the byte array</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="constructTraceID(byte[],int)">
<h3>constructTraceID</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">constructTraceID</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset)</span></div>
</section>
</li>
<li>
<section class="detail" id="constructUnsignedInt(byte[],int)">
<h3>constructUnsignedInt</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">constructUnsignedInt</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset)</span></div>
</section>
</li>
<li>
<section class="detail" id="constructUnsignedByte(byte[],int)">
<h3>constructUnsignedByte</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">constructUnsignedByte</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset)</span></div>
</section>
</li>
<li>
<section class="detail" id="constructString(byte[],int)">
<h3>constructString</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">constructString</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset)</span></div>
<div class="block">Constructs a string from an array of bytes, encoding is as specified in the properties</div>
</section>
</li>
<li>
<section class="detail" id="constructString(byte[],int,java.lang.String)">
<h3>constructString</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">constructString</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset,
<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>&nbsp;enc)</span></div>
<div class="block">Constructs a string from an array of bytes, with the specified encoding (ASCII or EBCDIC?)</div>
</section>
</li>
<li>
<section class="detail" id="constructString(byte[],int,int)">
<h3>constructString</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">constructString</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset,
int&nbsp;count)</span></div>
<div class="block">Constructs a string from an array of bytes with a count, encoding is as specified in the properties</div>
</section>
</li>
<li>
<section class="detail" id="escapeControlCharacters(java.lang.String)">
<h3>escapeControlCharacters</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">escapeControlCharacters</span>&#8203;<span class="parameters">(<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>&nbsp;string)</span></div>
<div class="block">Escapes control characters in the given string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>string</code> - </dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="escapeControlCharacters(java.lang.String,java.lang.String)">
<h3>escapeControlCharacters</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">escapeControlCharacters</span>&#8203;<span class="parameters">(<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>&nbsp;string,
<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>&nbsp;encoding)</span></div>
<div class="block">Escapes control characters in the given string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>string</code> - </dd>
<dd><code>encoding</code> - </dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="constructString(byte[],int,int,java.lang.String)">
<h3>constructString</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">constructString</span>&#8203;<span class="parameters">(byte[]&nbsp;data,
int&nbsp;offset,
int&nbsp;count,
<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>&nbsp;enc)</span></div>
<div class="block">Constructs a string from an array of bytes with an offset and count,
with the specified encoding (ASCII or EBCDIC).</div>
</section>
</li>
<li>
<section class="detail" id="setProperty(java.lang.String,java.lang.String)">
<h3>setProperty</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setProperty</span>&#8203;<span class="parameters">(<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>&nbsp;key,
<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>&nbsp;val)</span></div>
<div class="block">sets an property that affects the behavior of the formatter</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - </dd>
<dd><code>val</code> - </dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getProperty(java.lang.String)">
<h3>getProperty</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">getProperty</span>&#8203;<span class="parameters">(<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>&nbsp;key)</span></div>
<div class="block">gets an the value property that affecting behavior of the formatter</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - </dd>
<dt>Returns:</dt>
<dd>a string</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getProperty(java.lang.String,java.lang.String)">
<h3>getProperty</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">getProperty</span>&#8203;<span class="parameters">(<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>&nbsp;key,
<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>&nbsp;defaultValue)</span></div>
<div class="block">gets an the value property that affecting behavior of the formatter, if no such
property is set the default value is returned</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - </dd>
<dd><code>defaultValue</code> - </dd>
<dt>Returns:</dt>
<dd>a string</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="padBuffer(java.lang.StringBuffer,int,char)">
<h3>padBuffer</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">padBuffer</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link" target="_blank">StringBuffer</a>&nbsp;sb,
int&nbsp;i,
char&nbsp;c)</span></div>
</section>
</li>
<li>
<section class="detail" id="padBuffer(java.lang.StringBuffer,int,char,boolean)">
<h3>padBuffer</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">padBuffer</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/StringBuffer.html" title="class or interface in java.lang" class="external-link" target="_blank">StringBuffer</a>&nbsp;sb,
int&nbsp;i,
char&nbsp;c,
boolean&nbsp;leftJustified)</span></div>
</section>
</li>
<li>
<section class="detail" id="formatAsHexString(long)">
<h3>formatAsHexString</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">formatAsHexString</span>&#8203;<span class="parameters">(long&nbsp;number)</span></div>
<div class="block">Formats a number as a hex string, prefixing the "0x"
radix specifier so that it can be unambiguously
interpreted as a hex string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>number</code> - the number to format</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="convertEndian(int)">
<h3>convertEndian</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">convertEndian</span>&#8203;<span class="parameters">(int&nbsp;in)</span></div>
</section>
</li>
<li>
<section class="detail" id="convertAndCheckEyecatcher(int)">
<h3>convertAndCheckEyecatcher</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span>&nbsp;<span class="element-name">convertAndCheckEyecatcher</span>&#8203;<span class="parameters">(int&nbsp;eyecatcher)</span></div>
</section>
</li>
<li>
<section class="detail" id="setBigEndian(boolean)">
<h3>setBigEndian</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setBigEndian</span>&#8203;<span class="parameters">(boolean&nbsp;endian)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>